Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity
300 Commits 5 Branches 13 Tags
ec5a961f6c6c760928b1489a9b4eb92a3b52a514
Commit Graph
6 Commits
Author SHA1 Message Date
john-okeefe ed71ee5c99 docs(api): add comprehensive Collections API documentation 
Create detailed API reference for collection management endpoints:

Sections Included:
- Overview of collections feature
- All CRUD endpoints (Create, Read, Update, Delete, List)
- Book management endpoints (Add, Remove, Bulk Remove, List)
- Rule testing endpoint (Test rules before saving)
- Device shelf mapping endpoints
- Error response documentation
- Rate limiting information
- Bruno test collection references

Detailed Documentation:
- Request/response examples with actual JSON
- Path parameter descriptions
- Query parameter documentation
- Request body field specifications
- Supported rule fields and operators
- Sync direction options for shelf mappings
- Complete error response formats

Special Features Documented:
- Auto-assign rules with priority
- Per-device view settings
- Collection to shelf mapping
- Bulk operations efficiency
- Rule testing for preview
- Case-insensitive matching
- Numeric comparisons for years

API Endpoints Covered:
- GET /api/collections - List all collections
- POST /api/collections - Create collection
- GET /api/collections/{id} - Get collection details
- PUT /api/collections/{id} - Update collection
- DELETE /api/collections/{id} - Delete collection
- POST /api/collections/{id}/books - Add books
- DELETE /api/collections/{id}/books/{bookId} - Remove book
- POST /api/collections/{id}/books/bulk-remove - Bulk remove
- GET /api/collections/{id}/books - List collection books
- POST /api/collections/test-rules - Test rules
- GET /api/devices/{deviceId}/collections - Get shelf mappings
- POST /api/devices/{deviceId}/collections - Create mapping
- PUT /api/devices/{deviceId}/collections/{collectionId} - Update mapping
- DELETE /api/devices/{deviceId}/collections/{collectionId} - Delete mapping

This documentation enables developers to:
- Integrate collection management into third-party apps
- Build custom collection UIs
- Automate collection organization
- Integrate with mobile apps

Format: Markdown with code examples
Version: 1.0
Date: 2026-02-01
 2026-02-01 01:02:31 -05:00
john-okeefe 8ce6fa2011 docs(devices): add comprehensive OPDS wireless delivery documentation 
Update both Kobo and KOReader setup guides with OPDS workflow:

KOBO_SETUP.md Updates:
- New OPDS Wireless Book Delivery section
- Step-by-step OPDS configuration (automatic and manual)
- Browse and download books from Bookmann catalog
- Collection-based downloads
- Format support (EPUB, KEPUB, PDF)
- Automatic EPUB to KEPUB conversion
- Progress sync integration
- Collection to shelf mapping
- Troubleshooting section for OPDS issues
- OPDS vs USB transfer comparison table
- Advanced OPDS configuration options

KOREADER_SETUP.md Updates:
- OPDS catalog addition in KOReader
- Browse entire library wirelessly
- Download books and collections
- Automatic book matching
- Collection integration
- KOReader-specific OPDS settings
- Auto-download features
- Comprehensive troubleshooting
- OPDS tips and tricks
- Comparison table (OPDS vs USB)

Key Features Documented:
- Wireless book delivery (no USB cable needed)
- On-demand library browsing
- Collection-based organization
- Automatic progress sync for downloaded books
- Format conversion and optimization
- Device-specific configuration

Both guides now provide complete instructions for:
1. Setting up OPDS catalog on device
2. Browsing and downloading books
3. Troubleshooting common OPDS issues
4. Comparing wireless vs USB transfer methods
5. Advanced configuration options

This completes the OPDS documentation requirement for Phase 10.
 2026-02-01 01:02:09 -05:00
john-okeefe 74bf439e5e docs: refactor KOReader setup guide 
- Simplify and condense KOReader configuration documentation
- Remove redundant sections and improve clarity
 2026-01-31 18:25:32 -05:00
john-okeefe 33f26f3d7d docs: add implementation plan and update documentation 
- Add comprehensive implementation plan for universal sync system
- Update README with API reference and device setup guides
- Add KOBO_SETUP.md device configuration guide
 2026-01-31 18:25:27 -05:00
john-okeefe ab8f4f5351 docs/Code/bookmann/IMPLEMENTATION_PLAN.md: Add comprehensive implementation plan 
This plan implements:
- Universal book identification (SHA-256, UUID, ISBN, ASIN, OPF identifiers)
- Enhanced collection management with auto-assign rules
- OPDS-based wireless book delivery for Kobo, KOReader, Web, and Mobile
- Bidirectional progress sync with ContentId mapping
- Device-specific shelf mappings and configuration
- Complete database schema with 7 new tables
- 50+ documented API endpoints
- 10-week phased implementation plan

Features include:
- Cross-device book matching regardless of file paths
- Collections as device-neutral metadata with per-device shelf mapping
- Format conversion (EPUB → KEPUB) with hash integrity preservation
- Three-tier authentication (JWT, device tokens, OPDS)
- Two-layer architecture: OPDS for acquisition + internal APIs for state management

Key design principles:
1. Canonical UUID (Bookmann UUID) always wins for progress tracking
2. Collections ≠ device inventory - organizational metadata only
3. OPDS primary for all devices, internal APIs for web/mobile
4. Dual hash storage prevents format conversion issues

See IMPLEMENTATION_PLAN.md for complete technical details.
 2026-01-31 18:00:28 -05:00
john-okeefe 2801cf7432 Add comprehensive documentation for sync features 
- Add SECURITY_AUDIT.md with A- security rating
- Add SECURITY_ENHANCEMENTS.md for improvements
- Add DEVICE_CAP_IMPLEMENTATION.md complete guide
- Add KOREADER_SETUP.md device setup guide
- Add SYNC_USER_GUIDE.md user documentation
- Document all API endpoints and features
- Include security considerations and best practices
 2026-01-31 13:07:01 -05:00