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)

• Sync Configuration

  • Universal Sync Guide - Understanding sync, book matching, conflicts

• Frontend & Settings (Coming Soon)

  • Frontend Guide
  • User Areas Guide
  • Settings Guide
  • Admin Guide

👨‍💻 For Developers

Developer Documentation Portal - Technical documentation & API reference

• API Documentation

  • Complete API Reference - Monolithic REST API reference (1,300+ lines)
  • Split Endpoint Docs - Individual endpoints with interactive API Explorer
  • Collections API - Collections management API
  • Admin API - User management (admin operations)
  • 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 (feature coming soon)
  • WebSocket API - Real-time sync events

• Protocol Specifications

  • KOReader Sync Protocol - KOReader sync
  • Kobo Sync Protocol - Kobo device sync (coming soon)
  • WebSocket API - Real-time events

🔧 For Operations

Operations Documentation Portal - Deployment & maintenance

• Deployment

  • Troubleshooting Guide - Common deployment issues and solutions

• Maintenance (Coming Soon)

  • Deployment Guide
  • Maintenance Guide
  • Monitoring Guide

🤝 For Contributors

Contributing Portal - Development workflow

• Development Guide - Architecture, setup, testing
• ../PROJECT_GUIDELINES.md - Development rules and standards

---

📚 Quick Links

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

---

🔍 Quick Find

"How do I..."

Question	Answer
...install Bookhoard?	README.md - Quick Start
...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
...contribute code?	Development Guide

"Where is..."

Information	Location
...features list?	README.md
...database schema?	database/schema/schema.sql
...API endpoints?	API Reference
...secrets config?	.env.example
...operational config?	docker-compose.yml
...deployment issues?	Troubleshooting Guide

---

🎯 Common Workflows

Set up a new device

1. Choose your device: KOReader (works on Kindle, Kobo, and PocketBook hardware)
2. Understand sync: Sync Guide
3. Troubleshoot: Device-specific guides

Integrate with Bookhoard API

1. Start with API Reference
2. Explore Collections API
3. Review WebSocket API
4. Test with bruno/ collections

Deploy to production

1. Follow README.md quick start
2. Configure environment: .env.example
3. Review Troubleshooting Guide
4. Check Development Guide for performance tuning

---

📝 Contributing to Documentation

When adding new features:

1. User-facing features → Update relevant User docs
2. API endpoints → Update API Reference & split docs
3. Backend changes → Update Development Guide
4. Deployment changes → Update Operations Portal

Keep ../PROJECT_GUIDELINES.md in mind for documentation standards.

---

Last Updated: August 2026 Bookhoard Version: 1.0