BREAKING CHANGE: Documentation URLs have changed New structure: - user/ - End-user documentation (device setup, sync guides, frontend) - developer/ - Developer documentation (API reference, protocols, specs) - operations/ - Operations documentation (deployment, troubleshooting) - contributing/ - Contribution guides Changes: - Created portal INDEX.md files for each audience section - Moved device guides to user/devices/ (kobo-setup.md, koreader-setup.md) - Moved API docs to developer/ (api-reference.md, collections-api.md) - Moved sync guide to user/sync-guide.md - Moved troubleshooting to operations/troubleshooting.md - Moved all split API docs to developer/api/ - Renamed protocol files (kobo-protocol.md, koreader-protocol.md) - Added placeholder user guides (frontend, user-areas, settings, admin) - Updated all internal links to new paths - Updated Go code (http_handler.go, navigation.go) for new paths - Updated main INDEX.md for audience-based navigation Benefits: - Clear separation of user and developer documentation - Scalable structure for future user guide expansion - Better organization and discoverability - Audience-specific landing pages Related to DOCS_IMPLEMENTATION_PLAN.md Phase 2 completion
1.7 KiB
1.7 KiB
API Documentation
Complete reference for Bookhoard REST API endpoints.
Quick Links
- Authentication - User registration, login, tokens
- Users - Profile management
- Libraries - Library management
- Media Items - Book/ebook operations
- Progress - Reading progress tracking
- Notes - User notes management
- Highlights - Book highlights
- Ratings - Book ratings
- Devices - Device registration and sync
- Analytics - Usage statistics
- Book Matching - Search and link books
- Collections - See Collections API
- OPDS - Open Publication Distribution
- Sync Protocols - KOReader and Kobo sync
- WebSocket - Real-time sync events
Authentication
Users & Profiles
See User Management
Libraries
Media Items
Reading Progress
Notes & Highlights
See Notes Management and Highlights Management
Ratings
See Ratings System
Device Management
See Device Registration & Sync
Analytics
See Usage Analytics
Book Matching & Linking
See Book Matching
Collections
See Collections API or Collections Endpoints
OPDS
See OPDS Feeds
Sync Protocols
See KOReader Sync and Kobo Sync