0 Fork 0

Files

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

6.0 KiB

Raw Blame History

Bookhoard Documentation

Complete guide to Bookhoard documentation. Find what you need quickly.

🚀 By Audience

👤 For End Users

User Documentation Portal - Guides for using Bookhoard features

Device Setup
- KOReader Setup Guide - KOReader on Kindle/Kobo/PocketBook hardware
- Kobo Setup Guide - Native Kobo sync (coming soon; use KOReader today)
- Android App
Sync Configuration
- Universal Sync Guide - Understanding sync, book matching, conflicts
Filters
- Filters — the complete guide - rules, groups (ALL/ANY), saved filters, smart collections
- Filter cookbook - ready-made recipes, exact clicks
- Every filter field - the generated, always-current reference
Guides
- Reader Guide - reading, highlights, notes
- Library Browsing - browsing and searching your library
- Collections - manual and ⚡ smart shelves, books and episodes
- Podcasts - feeds, downloads, listening
- Dashboard
- Themes
- Calibre Integration
- Profile Guide
- Admin Guide

👨‍💻 For Developers

Developer Documentation Portal - Technical documentation & API reference

API Documentation — every endpoint is documented individually; the links below are entry points
- API Reference overview - index of all endpoint docs
- Collections API - collections management API
- Media Items API - media item operations including bulk operations and downloads
- Devices API - Device sync and shelf management
- Conflicts API - Sync conflict resolution endpoints
- Queue API - Sync queue management endpoints
- Scanner API - Library scanning and automated watch mode (admin)
- KOReader API - KOReader sync protocol endpoints
- Kobo API - Kobo sync protocol endpoints
- Admin API - User management (admin operations); content-duplicate cleanup lives in hash conflicts
Protocol Specifications
- KOReader Sync Protocol - KOReader sync
- Kobo Sync Protocol - Kobo device sync
Writing UI docs? Read Writing UI documentation without screenshots first.

🔧 For Operations

Operations Documentation Portal - Deployment & maintenance

Troubleshooting Guide - Common deployment issues and solutions

🤝 For Contributors

Contributing Portal - Development workflow

Development Guide - Architecture, setup, testing, and the project rules

📚 Quick Links

Want to...	Go to
Get started	Development Guide - Architecture and quick start
Set up a device	User Portal → Device Setup
Use the API	API Reference overview
Deploy Bookhoard	Operations → Troubleshooting
Contribute code	Development Guide
Understand sync	User Portal → Sync Guide
Read in the browser	User Portal → Web Reader Guide

🔍 Quick Find

"How do I..."

Question	Answer
...set up KOReader?	KOReader Setup Guide
...use a Kobo?	Kobo Setup Guide - native sync coming soon; KOReader works today
...understand sync?	Sync Guide
...read in the browser?	Web Reader Guide - reading, highlights, notes
...resolve conflicts?	Sync Guide - Managing Conflicts
...troubleshoot deployment?	Troubleshooting Guide
...use the API?	API Reference overview
...write UI docs?	Writing UI documentation
...contribute code?	Development Guide

📝 Contributing to Documentation

When adding new features:

User-facing features → Update the relevant User docs
API endpoints → Update the endpoint docs under developer/api/ (start from the API Reference overview)
Backend changes → Update the Development Guide
Deployment changes → Update the Operations Portal
New UI controls in docs → Add them to the UI controls glossary
UI appearances in docs → Follow Writing UI documentation without screenshots

6.0 KiB Raw Blame History