2 Commits

Include renames

Author	SHA1	Message	Date
john-okeefe	13db38e881	docs: simplify Calibre OPF implementation approach ... Update developer documentation to reflect simplified implementation approach based on user feedback. Key changes: - Rename extractMetadataFromCalibreSidecar() to extractCalibreSidecar() - Simplify function signature: return *MediaMetadata instead of (*MediaMetadata, error) - Replace wrapper function pattern with direct modification of extractMetadata() - Add code example showing simple if-check at top of extractMetadata() - Document benefits of simplified approach (40% less code, 0 call site changes) - Add implementation note explaining the simplification Benefits of simplified approach: - ~150 lines of code vs. ~250 lines (40% reduction) - No wrapper function needed - No call site changes required - Clearer single entry point for metadata extraction - Better testability - Easier to maintain This change simplifies the implementation while maintaining all functionality. The sidecar-first approach remains the same, but implementation is cleaner and more straightforward. See: CALIBRE_OPF_IMPLEMENTATION.md Decision 4 for full rationale	2026-03-26 10:42:32 -04:00
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