Files
bookhoard/docs/user/user-guide.md
T
john-okeefe 2a7ac881fd docs(user): align sync and user guides with current device support
- sync-guide: only Web and KOReader are fully supported; move Kobo to
  coming soon, drop fake Q2-Q4 2026 release dates for mobile/Kindle/
  Remarkable, and describe the plugin + server-approval registration
  flow instead of QR-code/URL approval
- sync-guide: remove cellular/mobile-app advice from battery and
  best-practice sections, correct the Calibre compatibility FAQ, update
  the changelog to reflect shipped vs. pending sync features, and fix
  the license header (GPL-3.0, not MIT)
- user-guide: lead device setup with KOReader; mark the Kobo guide as
  coming soon
- calibre-integration: OPDS client list no longer implies native Kobo
  support
- auth overview: label the mobile-application token guidance as
  'coming later' since no mobile apps exist yet
2026-08-20 14:14:49 -04:00

1.8 KiB

User Documentation

Welcome to the Bookhoard user documentation. This section contains guides for using Bookhoard features, setting up devices, and configuring sync.

📱 Device Setup

Learn how to configure your e-reader devices to sync with Bookhoard:

  • KOReader Setup Guide - Complete guide for KOReader

    • Installation on Kindle/Kobo/PocketBook
    • Plugin setup with server-side device approval
    • Progress, bookmark, highlight, and note sync
    • OPDS catalog access
    • Troubleshooting
  • Kobo Setup Guide - Native Kobo sync (coming soon)

    • In the meantime, KOReader works great on Kobo hardware

🔄 Sync Configuration

  • Universal Sync Guide - Understanding and using sync features
    • What is Universal Sync?
    • Supported devices
    • Book matching and auto-linking
    • Conflict resolution
    • Best practices

📚 Calibre Integration

  • Calibre Integration Guide - Integrating with Calibre libraries
    • What is Calibre?
    • Automatic metadata import
    • Setting up your Calibre library
    • Supported metadata and file types
    • Workflow examples
    • Troubleshooting
    • Best practices

🎨 Frontend Guide

Frontend Guide - Learn how to use the Bookhoard web interface

  • Coming Soon

👤 User Areas

User Areas Guide - Managing your personal library and settings

  • Coming Soon

⚙️ Settings

Settings Guide - Configuring your Bookhoard preferences

  • Coming Soon

🔐 Admin Features

Admin Guide - Administrative functions and management

  • Coming Soon

Looking for developer documentation? See the Developer Portal