John O'Keefe
913174cdf8
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.
116 lines
6.1 KiB
Markdown
116 lines
6.1 KiB
Markdown
# 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
|
|
- [Dashboard](user/dashboard.md)
|
|
- [Themes](user/themes.md)
|
|
- [Calibre Integration](user/calibre-integration.md)
|
|
- [Settings Guide](user/settings-guide.md)
|
|
- [Profile Guide](user/profile-guide.md)
|
|
- [Admin Guide](user/admin-guide.md)
|
|
- [Frontend Guide](user/frontend-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)
|