public/librenotes
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Create user, self-hosting, API, and contributing documentation #29

New Issue
Closed
opened 2026-02-25 16:05:18 +01:00 by libretech · 0 comments
libretech commented 2026-02-25 16:05:18 +01:00
Owner
Copy Link
Copy Source

Summary

Create comprehensive documentation covering four areas: user guide, self-hosting guide, API reference, and contributing guidelines.

Documentation Sections

User Guide

  • Getting started with librenot.es
  • Note creation, editing, and organization
  • Markdown syntax support
  • Keyboard shortcuts

Self-Hosting Guide

  • System requirements
  • Docker Compose deployment
  • Environment configuration
  • Backup and restore procedures
  • Reverse proxy setup (nginx/Caddy)

API Reference

  • Authentication endpoints
  • Notes CRUD endpoints
  • Request/response formats
  • Error codes

Contributing Guide

  • Development environment setup
  • Code style and conventions
  • Pull request process
  • Issue reporting guidelines

Acceptance Criteria

  • All four documentation sections are complete and reviewed
  • Self-hosting guide tested on a fresh system
  • API reference covers all public endpoints
  • Contributing guide enables a new developer to set up and submit a PR
## Summary Create comprehensive documentation covering four areas: user guide, self-hosting guide, API reference, and contributing guidelines. ## Documentation Sections ### User Guide - [x] Getting started with librenot.es - [x] Note creation, editing, and organization - [x] Markdown syntax support - [x] Keyboard shortcuts ### Self-Hosting Guide - [x] System requirements - [x] Docker Compose deployment - [x] Environment configuration - [x] Backup and restore procedures - [x] Reverse proxy setup (nginx/Caddy) ### API Reference - [x] Authentication endpoints - [x] Notes CRUD endpoints - [x] Request/response formats - [x] Error codes ### Contributing Guide - [x] Development environment setup - [x] Code style and conventions - [x] Pull request process - [x] Issue reporting guidelines ## Acceptance Criteria - [x] All four documentation sections are complete and reviewed - [ ] Self-hosting guide tested on a fresh system - [x] API reference covers all public endpoints - [x] Contributing guide enables a new developer to set up and submit a PR
libretech added the phase-6 label 2026-02-25 16:05:18 +01:00
libretech changed title from Write documentation to Create user, self-hosting, API, and contributing documentation 2026-02-25 22:47:07 +01:00
libretech added the documentationtask labels 2026-02-25 22:48:25 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
backend
Backend changes
 database
Database changes
 documentation
Documentation improvements
 epic
frontend
Frontend changes
 infrastructure
Infrastructure and deployment
 launch
Launch and release tasks
 phase-0
phase-1
phase-2
phase-3
phase-4
phase-5
phase-6
security
Security-related
 task
Actionable task
No labels documentation phase-6 task
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
libretech (Michael Czechowski) libretech-bot
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: public/librenotes#29