john-okeefe
4d321528b2
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
955 B
955 B
Operations Documentation
Welcome to the Bookhoard operations documentation. This section contains guides for deploying, maintaining, and troubleshooting Bookhoard instances.
🔧 Deployment
Quick Start
- Troubleshooting Guide - Common deployment issues and solutions
- Environment variables setup
- Port conflicts
- Container runtime (Podman)
- Network configuration
- Performance optimization
Additional Deployment Guides
Deployment Guide - Comprehensive deployment guide
- Coming Soon
🛠️ Maintenance
Maintenance Guide - Ongoing operations and maintenance
- Coming Soon
📊 Monitoring
Monitoring Guide - Monitoring and alerting
- Coming Soon
Looking for user documentation? See the User Portal Need API docs? See the Developer Portal