Bookhoard/bookhoard
0
0 Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 69 Wiki Activity
Files
12aab156f6ce4e5a1169cface098c845379b00d2
bookhoard/docs/index.md
T
John O'Keefe 9e2f216af5 docs(user): dashboard, browsing, profile rewrites + new podcasts guide; trash stubs 
Ground-truthed against the templates this pass:
- dashboard.md: real section kinds (system shelves incl. Continue
  Series, user collections, custom sections via /custom-section
  builder), Customize Dashboard panel semantics (per-library, drag,
  switches, 10-50 items, Save Changes), Refresh, This Week widget,
  per-item Read/Listen and progress-conflict resolve actions. The old
  page listed a wrong shelf set and never mentioned custom sections.
- library-browsing.md: the file was secretly titled 'Saving Custom
  Filters' and covered nothing else. Now the browsing page: All Books
  toolbar (search, Sort, Filters -> drawer hand-off, Save/Load/Clear
  saved filters), book detail as hub, series pages, podcasts split.
- profile-guide.md: field table ground-truthed from profile_form.templ
  (username/email DO remain editable there), audio defaults (speed,
  resume rewind, keep awake), timezone rendering contract, both theme
  doors (7-pick select vs 37-theme Appearance panel), Change Password
  with live checks, Danger Zone/Remove My Account + last-admin rule.
- podcasts.md NEW: the Podcasts page had zero documentation. Subscribing
  (Add Feed -> RSS URL, library, back-catalog download, download order,
  Add & Subscribe), Continue/All Feeds, Download All, player + Play as
  Sequence cross-link.
- Trashed user-areas.md, frontend-guide.md, settings-guide.md: stubs
  whose planned content now exists as real pages (or duplicates
  profile-guide). user-guide.md rewritten as the plain-language front
  door with a go-here-when table; index.md rows updated to match.
- ui-controls.md: 10 new gate-checked entries for every newly cited
  control (Add & Subscribe via templ-entity fragment).
2026-11-02 10:07:28 -05:00

115 lines
6.0 KiB
Markdown
Raw Blame History

# Bookhoard Documentation
Complete guide to Bookhoard documentation. Find what you need quickly.
---
## 🚀 By Audience
### 👤 For End Users
**[User Documentation Portal](user/user-guide.md)** - Guides for using Bookhoard features
- **Device Setup**
- [KOReader Setup Guide](user/devices/koreader-setup.md) - KOReader on Kindle/Kobo/PocketBook hardware
- [Kobo Setup Guide](user/devices/kobo-setup.md) - Native Kobo sync (coming soon; use KOReader today)
- [Android App](user/devices/android-app.md)
- **Sync Configuration**
- [Universal Sync Guide](user/sync-guide.md) - Understanding sync, book matching, conflicts
- **Filters**
- [Filters — the complete guide](user/filters/index.md) - rules, groups (ALL/ANY), saved filters, smart collections
- [Filter cookbook](user/filters/cookbook.md) - ready-made recipes, exact clicks
- [Every filter field](user/filters/fields.md) - the generated, always-current reference
- **Guides**
- [Reader Guide](user/reader-guide.md) - reading, highlights, notes
- [Library Browsing](user/library-browsing.md) - browsing and searching your library
- [Collections](user/collections.md) - manual and ⚡ smart shelves, books and episodes
- [Podcasts](user/podcasts.md) - feeds, downloads, listening
- [Dashboard](user/dashboard.md)
- [Themes](user/themes.md)
- [Calibre Integration](user/calibre-integration.md)
- [Profile Guide](user/profile-guide.md)
- [Admin Guide](user/admin-guide.md)
### 👨‍💻 For Developers
**[Developer Documentation Portal](developer/development.md)** - Technical documentation & API reference
- **API Documentation** — every endpoint is documented individually; the links below are entry points
- [API Reference overview](developer/api/api-reference.md) - index of all endpoint docs
- [Collections API](developer/api/collections/list_collections.md) - collections management API
- [Media Items API](developer/api/media-items/list_media_items.md) - media item operations including bulk operations and downloads
- [Devices API](developer/api/devices/list_devices.md) - Device sync and shelf management
- [Conflicts API](developer/api/conflicts/list_conflicts.md) - Sync conflict resolution endpoints
- [Queue API](developer/api/queue/list_all_queue_items.md) - Sync queue management endpoints
- [Scanner API](developer/api/scanner/overview.md) - Library scanning and automated watch mode (admin)
- [KOReader API](developer/api/koreader/get_library.md) - KOReader sync protocol endpoints
- [Kobo API](developer/api/kobo/sync_from_server.md) - Kobo sync protocol endpoints
- [Admin API](developer/api/admin/list_users.md) - User management (admin operations); content-duplicate cleanup lives in [hash conflicts](developer/api/admin/hash_conflicts_api.md)
- **Protocol Specifications**
- [KOReader Sync Protocol](developer/api/sync/koreader-protocol.md) - KOReader sync
- [Kobo Sync Protocol](developer/api/sync/kobo-protocol.md) - Kobo device sync
- **Writing UI docs?** Read [Writing UI documentation without screenshots](developer/writing-ui-docs.md) first.
### 🔧 For Operations
**[Operations Documentation Portal](operations/operations.md)** - Deployment & maintenance
- [Troubleshooting Guide](operations/troubleshooting.md) - Common deployment issues and solutions
### 🤝 For Contributors
**[Contributing Portal](contributing/contributing.md)** - Development workflow
- [Development Guide](contributing/development.md) - Architecture, setup, testing, and the project rules
---
## 📚 Quick Links
| Want to... | Go to |
| -------------------- | ---------------------------------------------------------------------- |
| **Get started** | [Development Guide](contributing/development.md) - Architecture and quick start |
| **Set up a device** | [User Portal → Device Setup](user/user-guide.md) |
| **Use the API** | [API Reference overview](developer/api/api-reference.md) |
| **Deploy Bookhoard** | [Operations → Troubleshooting](operations/troubleshooting.md) |
| **Contribute code** | [Development Guide](contributing/development.md) |
| **Understand sync** | [User Portal → Sync Guide](user/sync-guide.md) |
| **Read in the browser** | [User Portal → Web Reader Guide](user/reader-guide.md) |
---
## 🔍 Quick Find
### "How do I..."
| Question | Answer |
| --------------------------- | ------------------------------------------------------ |
| ...set up KOReader? | [KOReader Setup Guide](user/devices/koreader-setup.md) |
| ...use a Kobo? | [Kobo Setup Guide](user/devices/kobo-setup.md) - native sync coming soon; KOReader works today |
| ...understand sync? | [Sync Guide](user/sync-guide.md) |
| ...read in the browser? | [Web Reader Guide](user/reader-guide.md) - reading, highlights, notes |
| ...resolve conflicts? | [Sync Guide](user/sync-guide.md) - Managing Conflicts |
| ...troubleshoot deployment? | [Troubleshooting Guide](operations/troubleshooting.md) |
| ...use the API? | [API Reference overview](developer/api/api-reference.md) |
| ...write UI docs? | [Writing UI documentation](developer/writing-ui-docs.md) |
| ...contribute code? | [Development Guide](contributing/development.md) |
---
## 📝 Contributing to Documentation
When adding new features:
1. **User-facing features** → Update the relevant User docs
2. **API endpoints** → Update the endpoint docs under `developer/api/` (start from the [API Reference overview](developer/api/api-reference.md))
3. **Backend changes** → Update the [Development Guide](contributing/development.md)
4. **Deployment changes** → Update the [Operations Portal](operations/operations.md)
5. **New UI controls in docs** → Add them to the [UI controls glossary](developer/ui-controls.md)
6. **UI appearances in docs** → Follow [Writing UI documentation without screenshots](developer/writing-ui-docs.md)
Reference in new issue View Git Blame Copy Permalink