john-okeefe
4d321528b2
docs: update comprehensive API documentation and project guides
...
This commit updates all documentation files throughout the project:
- Updated IMPLEMENTATION_PLAN.md with new implementation details
- Updated PROJECT_GUIDELINES.md with coding standards and practices
- Updated README.md with current project information
- Updated SCREENSHOT_AUTOMATION.md with new automation details
- Added TEST_DATA.md with test fixtures data
- Updated cover_image_serving_plan.md with static URL patterns
Documentation API updates:
- Updated API reference documentation for all endpoints including:
- Authentication (login, logout, register, refresh_token)
- Book matching (auto_link, bulk_link, link_book, search)
- Collections (CRUD operations, shelf mappings, auto-assign rules)
- Conflicts (bulk operations, resolve/dismiss)
- Devices (registration, approval, shelf management)
- Highlights (create, update, delete, get)
- Kobo sync (bookmark, markup, initialization, sync)
- KOReader sync (library, metadata, bookmarks, progress)
- Libraries (CRUD, folders, media items, stats)
- Media items (bulk operations, CRUD)
- Notes (CRUD operations)
- OPDS (acquisition, feeds, publication)
- Progress (reading progress tracking)
- Queue (device queue management)
- Ratings (star ratings)
- Scanner (watch mode, scan operations)
- Sync protocols (Kobo, KOReader)
- Users (profile, password, admin operations)
- WebSocket protocols
- Updated user guides (admin, dashboard, settings, sync)
- Updated device setup guides (Kobo, KOReader)
- Updated developer guides (testing, contributing, operations)
- Updated scripts/README.md
2026-02-27 17:06:22 -05:00
john-okeefe
b44e4e4709
docs: remove Phase X placeholders from API documentation
...
Clean up API documentation files by removing Phase X references:
Remove 'API Explorer will be inserted here in Phase X' placeholders from:
- 70+ API endpoint documentation files
- Authentication endpoints (login, logout, register, refresh)
- User endpoints (profile, settings, password)
- Device endpoints (registration, sync, shelves)
- Library endpoints (CRUD, folders, visibility)
- Media endpoints (items, progress, highlights, notes)
- Admin endpoints (users, analytics)
- Sync endpoints (Kobo, KOReader)
- OPDS endpoints
- Scanner endpoints
- Queue endpoints
These placeholders were from planning documents and have no meaning
to API consumers. The documentation is now clean and ready for use.
2026-02-13 21:50:44 -05:00
john-okeefe
d43bd9526b
docs(api): add WebSocket real-time sync API documentation
...
- sync_api.md - Comprehensive WebSocket API guide
Covers:
- Connection and authentication (JWT + device)
- Client→Server messages (subscribe, ping)
- Server→Client messages (progress, conflicts, scan status, etc.)
- Message formats with examples
- Connection lifecycle
- Topics: progress, conflicts, scanner, devices, queue
- JavaScript usage example with reconnection
- Best practices for heartbeat and error handling
Documents bidirectional real-time sync API
2026-02-08 12:38:50 -05:00
john-okeefe