john-okeefe
c4607cd9b5
Complete API documentation audit covering all backend endpoints. Auth Endpoints: - Fixed endpoint paths from /api/users/me/* to /api/auth/* - Added update_email.md and update_username.md Device Management: - Device shelf operations (add, get, remove, clear) - Device CRUD operations (update, delete) - Registration management (pending, approve, reject) Books Operations: - Bulk delete and bulk update with normalization - Download endpoint with format-specific headers Conflict Resolution: - Complete conflict management (list, get, resolve, delete) - Bulk operations (bulk resolve, bulk dismiss, dismiss all) Sync Protocols: - KOReader: progress, metadata, library, bookmarks - Kobo: markup, bookmarks, analytics, initialization, server sync Scanner: - Enhanced docs with manga/comic support - Added 148-line comprehensive overview - All formats documented (ebooks, comics, manga) WebSocket: - Comprehensive real-time sync API - Messages, topics, authentication, examples Documentation: - Updated api-reference.md with all 122+ endpoints - Updated index.md with new categories Total: 36 new files, 6 modified files, 100% coverage
5.7 KiB
5.7 KiB
Bookhoard Documentation
Complete guide to Bookhoard documentation. Find what you need quickly.
🚀 By Audience
👤 For End Users
User Documentation Portal - Guides for using Bookhoard features
-
Device Setup
- Kobo Setup Guide - Complete Kobo e-reader configuration
- KOReader Setup Guide - KOReader on Kindle/Kobo/PocketBook
-
Sync Configuration
- Universal Sync Guide - Understanding sync, book matching, conflicts
-
Frontend & Settings (Coming Soon)
- Frontend Guide
- User Areas Guide
- Settings Guide
- Admin Guide
👨💻 For Developers
Developer Documentation Portal - Technical documentation & API reference
-
API Documentation
- Complete API Reference - Monolithic REST API reference (1,300+ lines)
- Split Endpoint Docs - Individual endpoints with interactive API Explorer
- Collections API - Collections management API
- Admin API - User management (admin operations)
- Books API - Bulk book operations and downloads
- Devices API - Device sync and shelf management
- Conflicts API - Sync conflict resolution endpoints
- Queue API - Sync queue management endpoints
- Scanner API - Library scanning and automated watch mode (admin)
- KOReader API - KOReader sync protocol endpoints
- Kobo API - Kobo sync protocol endpoints
- WebSocket API - Real-time sync events
-
Protocol Specifications
- Kobo Sync Protocol - Kobo device sync
- KOReader Sync Protocol - KOReader sync
- WebSocket API - Real-time events
🔧 For Operations
Operations Documentation Portal - Deployment & maintenance
-
Deployment
- Troubleshooting Guide - Common deployment issues and solutions
-
Maintenance (Coming Soon)
- Deployment Guide
- Maintenance Guide
- Monitoring Guide
🤝 For Contributors
Contributing Portal - Development workflow
- Development Guide - Architecture, setup, testing
- PROJECT_GUIDELINES.md - Development rules and standards
📚 Quick Links
| Want to... | Go to |
|---|---|
| Get started | README.md - Project overview and quick start |
| Set up a device | User Portal → Device Setup |
| Use the API | Developer Portal → API Docs |
| Deploy Bookhoard | Operations Portal → Troubleshooting |
| Contribute code | Contributing Portal → Development Guide |
| Understand sync | User Portal → Sync Guide |
🔍 Quick Find
"How do I..."
| Question | Answer |
|---|---|
| ...install Bookhoard? | README.md - Quick Start |
| ...set up my Kobo? | Kobo Setup Guide |
| ...set up KOReader? | KOReader Setup Guide |
| ...understand sync? | Sync Guide |
| ...resolve conflicts? | Sync Guide - Managing Conflicts |
| ...troubleshoot deployment? | Troubleshooting Guide |
| ...use the API? | API Reference |
| ...contribute code? | Development Guide |
"Where is..."
| Information | Location |
|---|---|
| ...features list? | README.md |
| ...database schema? | database/schema/schema.sql |
| ...API endpoints? | API Reference |
| ...secrets config? | .env.example |
| ...operational config? | docker-compose.yml |
| ...deployment issues? | Troubleshooting Guide |
🎯 Common Workflows
Set up a new device
- Choose your device: Kobo or KOReader
- Understand sync: Sync Guide
- Troubleshoot: Device-specific guides
Integrate with Bookhoard API
- Start with API Reference
- Explore Collections API
- Review WebSocket API
- Test with bruno/ collections
Deploy to production
- Follow README.md quick start
- Configure environment: .env.example
- Review Troubleshooting Guide
- Check Development Guide for performance tuning
📝 Contributing to Documentation
When adding new features:
- User-facing features → Update relevant User docs
- API endpoints → Update API Reference & split docs
- Backend changes → Update Development Guide
- Deployment changes → Update Operations Portal
Keep PROJECT_GUIDELINES.md in mind for documentation standards.
Last Updated: 2026-02-08 Bookhoard Version: 1.0