0 Fork 0

Files

T

John O'Keefe 913174cdf8 docs(gates): widen relative-link checker to all docs, repair the rot it finds

TestDocsRelativeLinks walked only docs/developer; widening it to all of
docs/ immediately surfaced the same class of rot the gate was built
for, outside its old reach:

- docs/index.md was the old monolith's landing page: linked the deleted
  api-reference.md, 10 directory-style area links, and escaped the docs
  tree to README/AGENTS/.env/compose. Rewritten as a portal whose every
  link resolves, with one representative endpoint doc per API area and
  pointers to the new writing-ui-docs.md standard.
- directory-style links in user stubs (devices/, ../operations/)
- case-mismatched links (Development.md) in contributing.md
- monolith-era pointer (API_REFERENCE.md, TROUBLESHOOTING.md) and
  escaped AGENTS.md links in contributing/development.md
- docs/development/calibre-opf-implementation.md double-up escapes, a
  link to the removed repo-root plan file (absorbed here), and a
  source-code hyperlink the docs site can't serve (now inline code)
- operations/operations.md linked three never-written guide pages as
  aspirational links - they stay plain text until pages exist

HANDS-OFF (project owner, 2026-11-02): docs/user/filters/** and
docs/user/searching-and-filtering.md are exempt as link sources so no
future checker failure can force edits to the filter documentation.
Files linking INTO them remain checked.

2026-11-02 08:21:47 -05:00

6.1 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
- Dashboard
- Themes
- Calibre Integration
- Settings Guide
- Profile Guide
- Admin Guide
- Frontend 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.1 KiB Raw Blame History