3 Commits

Include renames

Author	SHA1	Message	Date
john-okeefe	2a7ac881fd	docs(user): align sync and user guides with current device support ... - sync-guide: only Web and KOReader are fully supported; move Kobo to coming soon, drop fake Q2-Q4 2026 release dates for mobile/Kindle/ Remarkable, and describe the plugin + server-approval registration flow instead of QR-code/URL approval - sync-guide: remove cellular/mobile-app advice from battery and best-practice sections, correct the Calibre compatibility FAQ, update the changelog to reflect shipped vs. pending sync features, and fix the license header (GPL-3.0, not MIT) - user-guide: lead device setup with KOReader; mark the Kobo guide as coming soon - calibre-integration: OPDS client list no longer implies native Kobo support - auth overview: label the mobile-application token guidance as 'coming later' since no mobile apps exist yet	2026-08-20 14:14:49 -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	253f56399d	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	2026-02-02 15:58:34 -05:00