John O'Keefe
50282895f5
fix(docs): Work Order 2 — correct stale paths (11 docs + 3 Bruno)
...
Fix all wrong-path artifacts identified by the audit:
- Kobo sync endpoints (init/bookmark/markup/sync-from-server/analytics): add
missing :token device segment (6 doc files incl. kobo-protocol.md)
- Highlights/notes update+delete: add missing /:id media-item prefix
- media-items/download_media_item.md: removed (static /uploads route, not an
API endpoint; info about the file route is recoverable from OPDS docs)
- Bruno: /libraries/visible -> /visibility, /collections/books missing id,
/audio/0 -> track_index
- operations/troubleshooting.md: same /libraries/visible -> /visibility fix
- media-items/get_audio_track.md + get_audio_chapters.md: /audio/0 examples fixed
- Deleted monolithic docs/developer/api-reference.md (duplicate of split docs)
- Fixed 4 stale entries in docs/developer/api/api-reference.md (split index)
Audit re-run: orphan docs 0, orphan Bruno 6 (all scenario files with literal IDs).
2026-10-24 14:44:19 -04:00
john-okeefe
26f1f98736
docs(kobo): mark native Kobo sync as coming soon
...
Native Kobo sync is implemented server-side but not yet supported on
real devices, so stop documenting it as a working feature.
- Rewrite kobo-setup.md as a coming-soon stub: point users to KOReader
(which runs on Kobo hardware) as the supported path today, and list
what native sync will deliver when released
- Add 'Coming Soon' status banners to the Kobo protocol spec, all five
Kobo endpoint docs, and both API references, noting the endpoints are
under active development and may change
- Tag the device shelf endpoints as pending native Kobo support
2026-08-20 14:14:43 -04:00
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
c4607cd9b5
docs(api): complete backend documentation with all missing endpoints
...
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
2026-02-08 12:39:46 -05:00
John O'Keefe
john-okeefe