0 Fork 0

Files

T

John O'Keefe 393a00e8dd docs(nav): Administration section lives in docs/admin/; sidebar ordered by usability

Two structural changes, one owner-approved plan:

- Move the admin guides out of docs/user/ into their own docs/admin/
  area — admin-guide.md becomes the Administration section landing page
  (pinned first), and the 32-line admin-library-management.md stub
  becomes admin/libraries.md, which the admin-docs build-out rebuilds
  into the real Libraries page next. Retired URLs 301 via a new
  docRedirects map in the docs HTTP handler (checked before .md
  canonicalization so even .md spellings one-hop to the new clean URL);
  the two inbound links (docs index, user-guide front door) updated.

- Sidebar direct items now sort by usabilityOrder — an explicit,
  per-section display order — instead of alphabetically: User Guide
  mirrors the 'Where to go' table on user-guide.md, Devices orders
  Android → KOReader → Kobo (alphabetically Kobo used to sort ahead of
  KOReader), and Administration pre-lists its planned pages so each
  lands in place as the admin build writes it. Unlisted docs fall back
  to alphabetical after the listed ones. Display-order only by
  construction: the URL-driven expand/highlight machinery keys on
  containsURL membership and never sees sort order — nav tests updated
  to pin the new orders plus a real-tree test
  (TestBuildNavigationUsabilityOrder) guarding all three sections.

2026-11-02 13:38:01 -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