# 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**
  - [Kobo Setup Guide](user/devices/kobo-setup.md) - Complete Kobo e-reader configuration
  - [KOReader Setup Guide](user/devices/koreader-setup.md) - KOReader on Kindle/Kobo/PocketBook

- **Sync Configuration**
  - [Universal Sync Guide](user/sync-guide.md) - Understanding sync, book matching, conflicts

- **Frontend & Settings** (Coming Soon)
  - Frontend Guide
  - User Areas Guide
  - Settings Guide
  - Admin Guide

### 👨‍💻 For Developers

**[Developer Documentation Portal](developer/development.md)** - Technical documentation & API reference

  - **API Documentation**
    - [Complete API Reference](developer/api-reference.md) - Monolithic REST API reference (1,300+ lines)
     - [Split Endpoint Docs](developer/api/api-reference.md) - Individual endpoints with interactive API Explorer
    - [Collections API](developer/collections-api.md) - Collections management API
    - [Admin API](developer/api/admin/) - User management (admin operations)
    - [Media Items API](developer/api/media-items/) - Media item operations including bulk operations and downloads
    - [Devices API](developer/api/devices/) - Device sync and shelf management
    - [Conflicts API](developer/api/conflicts/) - Sync conflict resolution endpoints
    - [Queue API](developer/api/queue/) - Sync queue management endpoints
    - [Scanner API](developer/api/scanner/) - Library scanning and automated watch mode (admin)
    - [KOReader API](developer/api/koreader/) - KOReader sync protocol endpoints
    - [Kobo API](developer/api/kobo/) - Kobo sync protocol endpoints
    - [WebSocket API](developer/api/websocket/) - Real-time sync events

- **Protocol Specifications**
  - [Kobo Sync Protocol](developer/api/sync/kobo-protocol.md) - Kobo device sync
  - [KOReader Sync Protocol](developer/api/sync/koreader-protocol.md) - KOReader sync
  - [WebSocket API](developer/websocket-api.md) - Real-time events

### 🔧 For Operations

**[Operations Documentation Portal](operations/operations.md)** - Deployment & maintenance

- **Deployment**
  - [Troubleshooting Guide](operations/troubleshooting.md) - Common deployment issues and solutions

- **Maintenance** (Coming Soon)
  - Deployment Guide
  - Maintenance Guide
  - Monitoring Guide

### 🤝 For Contributors

**[Contributing Portal](contributing/contributing.md)** - Development workflow

 - [Development Guide](contributing/Development.md) - Architecture, setup, testing
- [PROJECT_GUIDELINES.md](PROJECT_GUIDELINES.md) - Development rules and standards

---

## 📚 Quick Links

| Want to... | Go to |
|------------|-------|
| **Get started** | [README.md](../README.md) - Project overview and quick start |
| **Set up a device** | [User Portal → Device Setup](user/user-guide.md) |
| **Use the API** | [Developer Portal → API Docs](developer/development.md) |
| **Deploy Bookhoard** | [Operations Portal → Troubleshooting](operations/troubleshooting.md) |
 | **Contribute code** | [Contributing Portal → Development Guide](contributing/Development.md) |
| **Understand sync** | [User Portal → Sync Guide](user/sync-guide.md) |

---

## 🔍 Quick Find

### "How do I..."

| Question | Answer |
|----------|--------|
| ...install Bookhoard? | [README.md](../README.md) - Quick Start |
| ...set up my Kobo? | [Kobo Setup Guide](user/devices/kobo-setup.md) |
| ...set up KOReader? | [KOReader Setup Guide](user/devices/koreader-setup.md) |
| ...understand sync? | [Sync Guide](user/sync-guide.md) |
| ...resolve conflicts? | [Sync Guide](user/sync-guide.md) - Managing Conflicts |
| ...troubleshoot deployment? | [Troubleshooting Guide](operations/troubleshooting.md) |
| ...use the API? | [API Reference](developer/api-reference.md) |
 | ...contribute code? | [Development Guide](contributing/Development.md) |

### "Where is..."

| Information | Location |
|-------------|----------|
| ...features list? | [README.md](../README.md) |
| ...database schema? | [database/schema/schema.sql](../database/schema/schema.sql) |
| ...API endpoints? | [API Reference](developer/api-reference.md) |
| ...secrets config? | [.env.example](../.env.example) |
| ...operational config? | [docker-compose.yml](../docker-compose.yml) |
| ...deployment issues? | [Troubleshooting Guide](operations/troubleshooting.md) |

---

## 🎯 Common Workflows

### Set up a new device
1. Choose your device: [Kobo](user/devices/kobo-setup.md) or [KOReader](user/devices/koreader-setup.md)
2. Understand sync: [Sync Guide](user/sync-guide.md)
3. Troubleshoot: Device-specific guides

### Integrate with Bookhoard API
1. Start with [API Reference](developer/api-reference.md)
2. Explore [Collections API](developer/collections-api.md)
3. Review [WebSocket API](developer/websocket-api.md)
4. Test with [bruno/](../bruno/) collections

### Deploy to production
1. Follow [README.md](../README.md) quick start
2. Configure environment: [.env.example](../.env.example)
3. Review [Troubleshooting Guide](operations/troubleshooting.md)
4. Check [Development Guide](contributing/Development.md) for performance tuning

---

## 📝 Contributing to Documentation

When adding new features:

1. **User-facing features** → Update relevant User docs
2. **API endpoints** → Update [API Reference](developer/api-reference.md) & split docs
3. **Backend changes** → Update [Development Guide](contributing/Development.md)
4. **Deployment changes** → Update [Operations Portal](operations/operations.md)

Keep [PROJECT_GUIDELINES.md](PROJECT_GUIDELINES.md) in mind for documentation standards.

---

**Last Updated**: 2026-02-08
**Bookhoard Version**: 1.0
