john-okeefe
35a039d720
- Renamed subdirectory INDEX.md files to section-specific names: - user/INDEX.md → user/user-guide.md - developer/INDEX.md → developer/development.md - operations/INDEX.md → operations/operations.md - contributing/INDEX.md → contributing/contributing.md - developer/api/INDEX.md → developer/api/api-reference.md - developer/api/collections/INDEX.md → developer/api/collections/collections-api.md - Updated all internal links to use new filenames - Updated navigation.go to skip subdirectory INDEX files from sidebar - Added Dockerfile to include docs directory in container build This fixes the issue where multiple 'INDEX' links appeared in the sidebar, making navigation confusing. Now each section has a descriptive name.
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