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
57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
# User Documentation
|
|
|
|
Welcome to the Bookhoard user documentation. This section contains guides for using Bookhoard features, setting up devices, and configuring sync.
|
|
|
|
## 📱 Device Setup
|
|
|
|
Learn how to configure your e-reader devices to sync with Bookhoard:
|
|
|
|
- **[Kobo Setup Guide](devices/kobo-setup.md)** - Complete guide for Kobo e-readers
|
|
- Device registration
|
|
- Sync configuration
|
|
- OPDS wireless book delivery
|
|
- Troubleshooting
|
|
|
|
- **[KOReader Setup Guide](devices/koreader-setup.md)** - Complete guide for KOReader
|
|
- Installation on Kindle/Kobo/PocketBook
|
|
- Sync setup
|
|
- OPDS catalog access
|
|
- Troubleshooting
|
|
|
|
## 🔄 Sync Configuration
|
|
|
|
- **[Universal Sync Guide](sync-guide.md)** - Understanding and using sync features
|
|
- What is Universal Sync?
|
|
- Supported devices
|
|
- Book matching and auto-linking
|
|
- Conflict resolution
|
|
- Best practices
|
|
|
|
## 🎨 Frontend Guide
|
|
|
|
**[Frontend Guide](frontend-guide.md)** - Learn how to use the Bookhoard web interface
|
|
|
|
- _Coming Soon_
|
|
|
|
## 👤 User Areas
|
|
|
|
**[User Areas Guide](user-areas.md)** - Managing your personal library and settings
|
|
|
|
- _Coming Soon_
|
|
|
|
## ⚙️ Settings
|
|
|
|
**[Settings Guide](settings-guide.md)** - Configuring your Bookhoard preferences
|
|
|
|
- _Coming Soon_
|
|
|
|
## 🔐 Admin Features
|
|
|
|
**[Admin Guide](admin-guide.md)** - Administrative functions and management
|
|
|
|
- _Coming Soon_
|
|
|
|
---
|
|
|
|
**Looking for developer documentation?** See the [Developer Portal](../developer/development.md)
|