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
parent 6562b20ee5
commit 4d321528b2
154 changed files with 2817 additions and 2152 deletions
@@ -27,19 +27,19 @@ Complete guide to Bookhoard documentation. Find what you need quickly.

 **[Developer Documentation Portal](developer/development.md)** - Technical documentation & API reference

-  - **API Documentation**
-    - [Complete API Reference](developer/api-reference.md) - Monolithic REST API reference (1,300+ lines)
-     - [Split Endpoint Docs](developer/api/api-reference.md) - Individual endpoints with interactive API Explorer
-    - [Collections API](developer/collections-api.md) - Collections management API
-    - [Admin API](developer/api/admin/) - User management (admin operations)
-    - [Media Items API](developer/api/media-items/) - Media item operations including bulk operations and downloads
-    - [Devices API](developer/api/devices/) - Device sync and shelf management
-    - [Conflicts API](developer/api/conflicts/) - Sync conflict resolution endpoints
-    - [Queue API](developer/api/queue/) - Sync queue management endpoints
-    - [Scanner API](developer/api/scanner/) - Library scanning and automated watch mode (admin)
-    - [KOReader API](developer/api/koreader/) - KOReader sync protocol endpoints
-    - [Kobo API](developer/api/kobo/) - Kobo sync protocol endpoints
-    - [WebSocket API](developer/api/websocket/) - Real-time sync events
+- **API Documentation**
+  - [Complete API Reference](developer/api-reference.md) - Monolithic REST API reference (1,300+ lines)
+  - [Split Endpoint Docs](developer/api/api-reference.md) - Individual endpoints with interactive API Explorer
+  - [Collections API](developer/collections-api.md) - Collections management API
+  - [Admin API](developer/api/admin/) - User management (admin operations)
+  - [Media Items API](developer/api/media-items/) - Media item operations including bulk operations and downloads
+  - [Devices API](developer/api/devices/) - Device sync and shelf management
+  - [Conflicts API](developer/api/conflicts/) - Sync conflict resolution endpoints
+  - [Queue API](developer/api/queue/) - Sync queue management endpoints
+  - [Scanner API](developer/api/scanner/) - Library scanning and automated watch mode (admin)
+  - [KOReader API](developer/api/koreader/) - KOReader sync protocol endpoints
+  - [Kobo API](developer/api/kobo/) - Kobo sync protocol endpoints
+  - [WebSocket API](developer/api/websocket/) - Real-time sync events

 - **Protocol Specifications**
  - [Kobo Sync Protocol](developer/api/sync/kobo-protocol.md) - Kobo device sync
@@ -62,21 +62,21 @@ Complete guide to Bookhoard documentation. Find what you need quickly.

 **[Contributing Portal](contributing/contributing.md)** - Development workflow

- - [Development Guide](contributing/Development.md) - Architecture, setup, testing
+- [Development Guide](contributing/Development.md) - Architecture, setup, testing
 - [PROJECT_GUIDELINES.md](PROJECT_GUIDELINES.md) - Development rules and standards

 ---

 ## 📚 Quick Links

-| Want to... | Go to |
-|------------|-------|
-| **Get started** | [README.md](../README.md) - Project overview and quick start |
-| **Set up a device** | [User Portal → Device Setup](user/user-guide.md) |
-| **Use the API** | [Developer Portal → API Docs](developer/development.md) |
-| **Deploy Bookhoard** | [Operations Portal → Troubleshooting](operations/troubleshooting.md) |
- | **Contribute code** | [Contributing Portal → Development Guide](contributing/Development.md) |
-| **Understand sync** | [User Portal → Sync Guide](user/sync-guide.md) |
+| Want to...           | Go to                                                                  |
+| -------------------- | ---------------------------------------------------------------------- |
+| **Get started**      | [README.md](../README.md) - Project overview and quick start           |
+| **Set up a device**  | [User Portal → Device Setup](user/user-guide.md)                       |
+| **Use the API**      | [Developer Portal → API Docs](developer/development.md)                |
+| **Deploy Bookhoard** | [Operations Portal → Troubleshooting](operations/troubleshooting.md)   |
+| **Contribute code**  | [Contributing Portal → Development Guide](contributing/Development.md) |
+| **Understand sync**  | [User Portal → Sync Guide](user/sync-guide.md)                         |

 ---

@@ -84,44 +84,47 @@ Complete guide to Bookhoard documentation. Find what you need quickly.

 ### "How do I..."

-| Question | Answer |
-|----------|--------|
-| ...install Bookhoard? | [README.md](../README.md) - Quick Start |
-| ...set up my Kobo? | [Kobo Setup Guide](user/devices/kobo-setup.md) |
-| ...set up KOReader? | [KOReader Setup Guide](user/devices/koreader-setup.md) |
-| ...understand sync? | [Sync Guide](user/sync-guide.md) |
-| ...resolve conflicts? | [Sync Guide](user/sync-guide.md) - Managing Conflicts |
+| Question                    | Answer                                                 |
+| --------------------------- | ------------------------------------------------------ |
+| ...install Bookhoard?       | [README.md](../README.md) - Quick Start                |
+| ...set up my Kobo?          | [Kobo Setup Guide](user/devices/kobo-setup.md)         |
+| ...set up KOReader?         | [KOReader Setup Guide](user/devices/koreader-setup.md) |
+| ...understand sync?         | [Sync Guide](user/sync-guide.md)                       |
+| ...resolve conflicts?       | [Sync Guide](user/sync-guide.md) - Managing Conflicts  |
 | ...troubleshoot deployment? | [Troubleshooting Guide](operations/troubleshooting.md) |
-| ...use the API? | [API Reference](developer/api-reference.md) |
- | ...contribute code? | [Development Guide](contributing/Development.md) |
+| ...use the API?             | [API Reference](developer/api-reference.md)            |
+| ...contribute code?         | [Development Guide](contributing/Development.md)       |

 ### "Where is..."

-| Information | Location |
-|-------------|----------|
-| ...features list? | [README.md](../README.md) |
-| ...database schema? | [database/schema/schema.sql](../database/schema/schema.sql) |
-| ...API endpoints? | [API Reference](developer/api-reference.md) |
-| ...secrets config? | [.env.example](../.env.example) |
-| ...operational config? | [docker-compose.yml](../docker-compose.yml) |
-| ...deployment issues? | [Troubleshooting Guide](operations/troubleshooting.md) |
+| Information            | Location                                                    |
+| ---------------------- | ----------------------------------------------------------- |
+| ...features list?      | [README.md](../README.md)                                   |
+| ...database schema?    | [database/schema/schema.sql](../database/schema/schema.sql) |
+| ...API endpoints?      | [API Reference](developer/api-reference.md)                 |
+| ...secrets config?     | [.env.example](../.env.example)                             |
+| ...operational config? | [docker-compose.yml](../docker-compose.yml)                 |
+| ...deployment issues?  | [Troubleshooting Guide](operations/troubleshooting.md)      |

 ---

 ## 🎯 Common Workflows

 ### Set up a new device
+
 1. Choose your device: [Kobo](user/devices/kobo-setup.md) or [KOReader](user/devices/koreader-setup.md)
 2. Understand sync: [Sync Guide](user/sync-guide.md)
 3. Troubleshoot: Device-specific guides

 ### Integrate with Bookhoard API
+
 1. Start with [API Reference](developer/api-reference.md)
 2. Explore [Collections API](developer/collections-api.md)
 3. Review [WebSocket API](developer/websocket-api.md)
 4. Test with [bruno/](../bruno/) collections

 ### Deploy to production
+
 1. Follow [README.md](../README.md) quick start
 2. Configure environment: [.env.example](../.env.example)
 3. Review [Troubleshooting Guide](operations/troubleshooting.md)