john-okeefe
22fd28c7db
docs: add comprehensive Calibre integration documentation
...
This commit adds complete documentation for the planned Calibre
metadata.opf sidecar file support feature.
## New Documentation
### Implementation Planning
- CALIBRE_OPF_IMPLEMENTATION.md: Detailed implementation plan with
requirements, architecture, database mapping, and step-by-step
implementation guide for adding Calibre metadata.opf support
### Technical Documentation
- docs/development/calibre-opf-implementation.md: Technical implementation
details including:
- Scanner pipeline architecture with sidecar-first approach
- Data structures (CalibreOPFMetadata, MediaMetadata)
- Function signatures and logic for parseCalibreMetadataOPF()
- Database schema mapping (no changes required)
- Testing strategy (unit and integration tests)
- Error handling and performance considerations
- Code examples and benchmarking approach
### User Documentation
- docs/user/calibre-integration.md: Comprehensive user guide covering:
- What is Calibre and how Bookhoard integrates with it
- Automatic metadata import from metadata.opf sidecar files
- Supported metadata fields (Dublin Core + Calibre-specific)
- Setup instructions for Calibre libraries
- Workflow examples (fresh library, mixed library, updating metadata)
- Troubleshooting common issues
- Best practices for Calibre + Bookhoard workflow
- FAQ and resources
## Updated Documentation
- README.md: Added Calibre integration feature to media management section
- docs/user/user-guide.md: Added link to Calibre integration guide
- docs/developer/development.md: Added link to Calibre implementation guide
## Feature Summary
The Calibre integration feature will allow Bookhoard to automatically
import curated metadata from Calibre's metadata.opf sidecar files,
including titles, authors, series, tags, descriptions, publishers,
identifiers (ISBN/ASIN), and contributors. Uses sidecar-first approach:
metadata.opf → embedded metadata → folder structure → filename.
All database fields already exist; no schema changes required.
2026-03-26 10:34:15 -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