john-okeefe
4d321528b2
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
52 lines
1.4 KiB
Markdown
52 lines
1.4 KiB
Markdown
# Dashboard
|
|
|
|
The Bookhoard dashboard provides a Carousel-style horizontal carousel interface for browsing your book library.
|
|
|
|
## Sections
|
|
|
|
### Smart Sections
|
|
|
|
Smart sections are automatically generated based on your reading activity:
|
|
|
|
- **Continue Reading**: Books you're currently reading (progress between 0-100%)
|
|
- **In Progress**: Books you've started (progress > 0%)
|
|
- **Recently Added**: Newest items added to this library
|
|
- **Recently Read**: Books you've completed (100% progress)
|
|
- **Not Started**: Books you haven't read yet
|
|
|
|
### User Collections
|
|
|
|
Any collection marked with "Show on Dashboard" will appear as a section on your dashboard.
|
|
|
|
To enable a collection:
|
|
|
|
1. Go to Collections
|
|
2. Edit a collection
|
|
3. Toggle "Show on Dashboard"
|
|
4. Save
|
|
|
|
### Customizing Your Dashboard
|
|
|
|
1. Click the ⚙️ (gear icon) in the top-right
|
|
2. **Drag sections** to reorder them
|
|
3. **Toggle visibility** with the switches
|
|
4. **Adjust items per section** (10-50 items)
|
|
5. Click "Save Changes"
|
|
|
|
Settings are saved per library.
|
|
|
|
### Library Switching
|
|
|
|
Use the dropdown in the sticky header to switch between libraries. Each library has its own dashboard settings.
|
|
|
|
### Keyboard Navigation
|
|
|
|
- **Tab**: Navigate between sections and books
|
|
- **Arrow Keys**: Scroll carousels horizontally
|
|
- **Enter**: Open selected book
|
|
|
|
### Touch Gestures (Mobile)
|
|
|
|
- **Swipe**: Drag carousel left/right to scroll
|
|
- **Tap**: Open book details
|