john-okeefe
253f56399d
BREAKING CHANGE: Documentation URLs have changed New structure: - user/ - End-user documentation (device setup, sync guides, frontend) - developer/ - Developer documentation (API reference, protocols, specs) - operations/ - Operations documentation (deployment, troubleshooting) - contributing/ - Contribution guides Changes: - Created portal INDEX.md files for each audience section - Moved device guides to user/devices/ (kobo-setup.md, koreader-setup.md) - Moved API docs to developer/ (api-reference.md, collections-api.md) - Moved sync guide to user/sync-guide.md - Moved troubleshooting to operations/troubleshooting.md - Moved all split API docs to developer/api/ - Renamed protocol files (kobo-protocol.md, koreader-protocol.md) - Added placeholder user guides (frontend, user-areas, settings, admin) - Updated all internal links to new paths - Updated Go code (http_handler.go, navigation.go) for new paths - Updated main INDEX.md for audience-based navigation Benefits: - Clear separation of user and developer documentation - Scalable structure for future user guide expansion - Better organization and discoverability - Audience-specific landing pages Related to DOCS_IMPLEMENTATION_PLAN.md Phase 2 completion
1.4 KiB
1.4 KiB
Collections API
See Collections API for complete collections documentation.
Quick Links
- List Collections - Get all collections
- Get Collection - Get collection details
- Create Collection - Create a new collection
- Update Collection - Update collection metadata
- Delete Collection - Delete a collection
- Add Auto-Assign Rule - Add automatic book assignment rule
- Remove Auto-Assign Rule - Remove assignment rule
- Test Rule - Test assignment rule
- Bulk Assign - Bulk assign books to collection
- Create Shelf Mapping - Map collection to device shelf
- Delete Shelf Mapping - Remove shelf mapping
Overview
Collections allow you to organize your books into custom groups with automatic assignment rules.
Features
- Manual Assignment: Add specific books to collections
- Auto-Assignment: Define rules to automatically assign books based on metadata
- Device Sync: Collections sync as shelves on Kobo/KOReader devices
- Flexible Rules: Filter by genre, series, tags, and more
See Also
- Collections API - Complete API reference
- Sync Guide - How collections sync to devices