docs: restructure documentation into audience-based portals

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
This commit is contained in:
2026-02-02 15:58:34 -05:00
parent ece90c0f1f
commit 253f56399d
76 changed files with 372 additions and 207 deletions
+77
View File
@@ -0,0 +1,77 @@
# Developer Documentation
Welcome to the Bookhoard developer documentation. This section contains API references, protocol specifications, and technical documentation for integrating with Bookhoard.
## 📚 API Documentation
### Complete API Reference
- **[API Reference](api-reference.md)** - Complete REST API reference
- Authentication
- User management
- Libraries
- Media items
- Reading progress
- Notes & highlights
- Analytics
- Book matching
- OPDS
- Sync protocols (KOReader, Kobo)
- WebSocket
### Split Endpoint Documentation
Browse individual endpoint documentation with interactive API Explorer:
- **[API Documentation](api/INDEX.md)** - Split endpoint docs
- [Authentication](api/authentication/) - Register, login, tokens
- [Users](api/users/) - Profile management
- [Libraries](api/libraries/) - Library operations
- [Media Items](api/media-items/) - Book/ebook management
- [Progress](api/progress/) - Reading progress tracking
- [Notes](api/notes/) - User notes
- [Highlights](api/highlights/) - Book highlights
- [Ratings](api/ratings/) - Book ratings
- [Devices](api/devices/) - Device management
- [Analytics](api/analytics/) - Usage statistics
- [Book Matching](api/book-matching/) - Search and link books
- [Collections](api/collections/) - Collection management
- [OPDS](api/opds/) - Open Publication Distribution
- [Sync Protocols](api/sync/) - KOReader and Kobo sync
- [WebSocket](api/websocket/) - Real-time events
### Collections API
- **[Collections API](collections-api.md)** - Complete collections API reference
- Create and manage collections
- Auto-assign rules
- Test rules
- Bulk operations
- Device shelf mappings
## 🔌 Protocol Specifications
### Sync Protocols
- **[Kobo Sync Protocol](api/sync/kobo-protocol.md)** - Kobo device sync protocol
- Kobo markup sync
- Library fetch
- Authentication
- **[KOReader Sync Protocol](api/sync/koreader-protocol.md)** - KOReader sync protocol
- Progress sync
- Metadata fetch
- Conflict handling
### WebSocket Protocol
- **[WebSocket API](websocket-api.md)** - Real-time sync and events
- Connection flow
- Message format
- Event types
- Authentication
---
**Looking for user documentation?** See the [User Portal](../user/INDEX.md)
**Need to deploy?** See the [Operations Portal](../operations/INDEX.md)