bookhoard/docs/index.md

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

🛡 For Administrators

Admin Guide - running a Bookhoard instance: every admin page, what each control actually does

• Administration
  • Admin Dashboard - stats, Force Rescan All Libraries, scan progress
  • Libraries - create libraries, folders, user access, scanning
  • Processing Issues - items the scanner couldn't process
  • Archived Items - missing files, history-preserving archive
  • All Podcasts - the maintenance view for every feed
  • Hash Conflicts - duplicate content resolution
  • Users - accounts, roles, password resets
  • System Settings - every setting: key, default, range, meaning
  • Scanning - shallow vs. force: what every scan button does

👨‍💻 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:

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)
3. Backend changes → Update the Development Guide
4. Deployment changes → Update the Operations Portal
5. New UI controls in docs → Add them to the UI controls glossary
6. UI appearances in docs → Follow Writing UI documentation without screenshots