john-okeefe
35a039d720
- Renamed subdirectory INDEX.md files to section-specific names: - user/INDEX.md → user/user-guide.md - developer/INDEX.md → developer/development.md - operations/INDEX.md → operations/operations.md - contributing/INDEX.md → contributing/contributing.md - developer/api/INDEX.md → developer/api/api-reference.md - developer/api/collections/INDEX.md → developer/api/collections/collections-api.md - Updated all internal links to use new filenames - Updated navigation.go to skip subdirectory INDEX files from sidebar - Added Dockerfile to include docs directory in container build This fixes the issue where multiple 'INDEX' links appeared in the sidebar, making navigation confusing. Now each section has a descriptive name.
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