Files

T

john-okeefe 4d321528b2 docs: update comprehensive API documentation and project guides

This commit updates all documentation files throughout the project:

- Updated IMPLEMENTATION_PLAN.md with new implementation details
- Updated PROJECT_GUIDELINES.md with coding standards and practices
- Updated README.md with current project information
- Updated SCREENSHOT_AUTOMATION.md with new automation details
- Added TEST_DATA.md with test fixtures data
- Updated cover_image_serving_plan.md with static URL patterns

Documentation API updates:
- Updated API reference documentation for all endpoints including:
  - Authentication (login, logout, register, refresh_token)
  - Book matching (auto_link, bulk_link, link_book, search)
  - Collections (CRUD operations, shelf mappings, auto-assign rules)
  - Conflicts (bulk operations, resolve/dismiss)
  - Devices (registration, approval, shelf management)
  - Highlights (create, update, delete, get)
  - Kobo sync (bookmark, markup, initialization, sync)
  - KOReader sync (library, metadata, bookmarks, progress)
  - Libraries (CRUD, folders, media items, stats)
  - Media items (bulk operations, CRUD)
  - Notes (CRUD operations)
  - OPDS (acquisition, feeds, publication)
  - Progress (reading progress tracking)
  - Queue (device queue management)
  - Ratings (star ratings)
  - Scanner (watch mode, scan operations)
  - Sync protocols (Kobo, KOReader)
  - Users (profile, password, admin operations)
  - WebSocket protocols

- Updated user guides (admin, dashboard, settings, sync)
- Updated device setup guides (Kobo, KOReader)
- Updated developer guides (testing, contributing, operations)
- Updated scripts/README.md

2026-02-27 17:06:22 -05:00

6.4 KiB

Raw Permalink 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
- Kobo Setup Guide - Complete Kobo e-reader configuration
- KOReader Setup Guide - KOReader on Kindle/Kobo/PocketBook
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
- WebSocket API - Real-time sync events
Protocol Specifications
- Kobo Sync Protocol - Kobo device sync
- KOReader Sync Protocol - KOReader sync
- 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

🔍 Quick Find

"How do I..."

Question	Answer
...install Bookhoard?	README.md - Quick Start
...set up my Kobo?	Kobo Setup Guide
...set up KOReader?	KOReader Setup Guide
...understand sync?	Sync Guide
...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

Choose your device: Kobo or KOReader
Understand sync: Sync Guide
Troubleshoot: Device-specific guides

Integrate with Bookhoard API

Start with API Reference
Explore Collections API
Review WebSocket API
Test with bruno/ collections

Deploy to production

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

📝 Contributing to Documentation

When adding new features:

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

Keep PROJECT_GUIDELINES.md in mind for documentation standards.

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

6.4 KiB Raw Permalink Blame History