Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs(user): align sync and user guides with current device support

Browse Source 
- 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
This commit is contained in:
john-okeefe
2026-08-20 14:14:49 -04:00
parent 26f1f98736
commit 2a7ac881fd
4 changed files with 44 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/authentication/overview.md
+1 -1
View File
@@ -158,7 +158,7 @@ The frontend toast.js interceptor:
- **Backend**: Automatically manages HTTP-only cookie - **Backend**: Automatically manages HTTP-only cookie
- **Frontend**: Store tokens in localStorage for API calls - **Frontend**: Store tokens in localStorage for API calls
### Mobile Applications ### Mobile Applications (coming later)
- Store access token in secure storage (Keychain/Keystore) - Store access token in secure storage (Keychain/Keystore)
- Store refresh token in secure storage - Store refresh token in secure storage
docs/user/calibre-integration.md
+3 -4
View File
@@ -259,12 +259,11 @@ Stay tuned for updates!
### OPDS Integration ### OPDS Integration
You can access your Bookhoard library (including Calibre-imported books) via OPDS from Calibre-aware devices: You can access your Bookhoard library (including Calibre-imported books) via OPDS from OPDS-capable clients:
- Kobo e-readers - KOReader (Kindle, Kobo, PocketBook hardware)
- KOReader
- Phone/tablet apps (KYBook, Chunky, etc.) - Phone/tablet apps (KYBook, Chunky, etc.)
See the [Kobo Setup Guide](devices/kobo-setup.md) or [KOReader Setup Guide](devices/koreader-setup.md) for details. See the [KOReader Setup Guide](devices/koreader-setup.md) for details.
## FAQ ## FAQ
docs/user/sync-guide.md
+35 -32
View File
@@ -21,7 +21,7 @@
🔄 **Automatic Sync** - Your reading progress syncs automatically when you turn pages 🔄 **Automatic Sync** - Your reading progress syncs automatically when you turn pages
📱 **Multi-Platform** - Works with web browsers, KOReader, Kobo devices, and mobile apps 📱 **Multi-Platform** - Works with web browsers and KOReader, with native Kobo sync and mobile apps on the roadmap
📍 **Precise Location Tracking** - Supports EPUB CFI, page numbers, percentages, and character offsets 📍 **Precise Location Tracking** - Supports EPUB CFI, page numbers, percentages, and character offsets
@@ -37,19 +37,24 @@
### Currently Supported ✅ ### Currently Supported ✅
| Platform | Status | Sync Method | Notes | | Platform | Status | Sync Method | Notes |
| ---------------- | ------------------ | --------------------------- | ------------------------------ | | ---------------- | ------------------ | --------------------------- | ---------------------------------- |
| **Web Browser** | ✅ Fully Supported | Real-time WebSocket | Any modern browser | | **Web Browser** | ✅ Fully Supported | Real-time WebSocket | Any modern browser |
| **KOReader** | ✅ Fully Supported | Wi-Fi (Calibre-compatible) | Kindle, Kobo, PocketBook, etc. | | **KOReader** | ✅ Fully Supported | Wi-Fi (Bookhoard plugin) | Kindle, Kobo, PocketBook hardware |
| **Kobo Devices** | ✅ Fully Supported | Wi-Fi (Kobo API-compatible) | Clara, Libra, Sage, etc. |
### Coming Soon 🚧 ### Coming Soon 🚧
| Platform | Expected Release | | Platform | Status |
| --------------------- | ---------------- | | --------------------- | ------------------------------------------------------------- |
| **Mobile Apps** | Q2 2026 | | **Kobo Devices** | Native sync coming soon — use KOReader on Kobo hardware today |
| **Kindle Devices** | Q3 2026 | | **Mobile Apps** | Android/iOS apps coming later |
| **Remarkable Tablet** | Q4 2026 |
### On the Roadmap 🔭
| Platform | Status |
| --------------------- | ---------------------------------------- |
| **Kindle Devices** | Under consideration (no date yet) |
| **Remarkable Tablet** | Under consideration (no date yet) |
--- ---
@@ -74,17 +79,16 @@
For detailed device configuration instructions, see the appropriate setup guide: For detailed device configuration instructions, see the appropriate setup guide:
- **[Kobo Setup Guide](devices/kobo-setup.md)** - Kobo e-reader configuration - **[KOReader Setup Guide](devices/koreader-setup.md)** - KOReader configuration (Kindle, Kobo, and PocketBook hardware)
- **[KOReader Setup Guide](devices/koreader-setup.md)** - KOReader configuration - **[Kobo Setup Guide](devices/kobo-setup.md)** - Native Kobo sync (coming soon; use KOReader today)
### Quick Overview ### Quick Overview
**Registration Process**: **Registration Process** (KOReader):
1. Register device in Bookhoard web interface (Settings → Devices) 1. Install the Bookhoard plugin and enter your server URL in KOReader
2. Approve device via QR code or approval URL 2. Approve the pending registration in Bookhoard (**Settings → Devices**)
3. Configure sync settings on your device 3. That's it — sync starts automatically once approved
4. Start reading - progress syncs automatically!
**Device Management**: **Device Management**:
@@ -331,7 +335,7 @@ This ensures your highlights work across all devices, even with different page c
1. Switch to checkpoint mode 1. Switch to checkpoint mode
2. Increase sync interval 2. Increase sync interval
3. Use Wi-Fi instead of cellular (for mobile) 3. Sync less frequently
--- ---
@@ -341,7 +345,7 @@ This ensures your highlights work across all devices, even with different page c
✅ **DO**: ✅ **DO**:
- Use checkpoint mode when on cellular data - Use checkpoint mode when on slow connections
- Keep device firmware updated - Keep device firmware updated
- Use Wi-Fi when available - Use Wi-Fi when available
- Approve only devices you own - Approve only devices you own
@@ -369,7 +373,7 @@ This ensures your highlights work across all devices, even with different page c
- **Primary Device**: KOReader on e-reader - **Primary Device**: KOReader on e-reader
- **Secondary Device**: Web browser (work/home) - **Secondary Device**: Web browser (work/home)
- **Mobile Device**: Phone app (commute) - **On the go**: Web browser on a phone (dedicated mobile apps coming later)
**Sync Strategy**: **Sync Strategy**:
@@ -503,9 +507,8 @@ Book → Reading History
### For Better Battery Life ### For Better Battery Life
1. **Checkpoint mode** - Fewer sync requests 1. **Checkpoint mode** - Fewer sync requests
2. **Wi-Fi only** - Disable cellular 2. **Increase sync interval** - Fewer updates
3. **Increase sync interval** - Fewer updates 3. **Close when not reading** - Reduces background activity
4. **Close when not reading** - Reduces background activity
--- ---
@@ -537,7 +540,7 @@ A: Approximately 1KB per page turn, 50KB per annotation.
A: Uses percentage and EPUB CFI for universal positioning. A: Uses percentage and EPUB CFI for universal positioning.
**Q: Can I sync with Calibre anymore?** **Q: Can I sync with Calibre anymore?**
A: Yes! KOReader sync is Calibre-compatible. A: Bookhoard's KOReader sync uses a dedicated plugin (server-side approval, device tokens) — no Calibre involvement required.
**Q: What if I lose my device?** **Q: What if I lose my device?**
A: Revoke it in settings and register a new one. A: Revoke it in settings and register a new one.
@@ -571,18 +574,18 @@ A: Yes, HTTPS/TLS 1.3 for all sync traffic.
## Changelog ## Changelog
### Version 1.0.0 (January 2026) ### Version 1.0.x (2026)
- ✅ Initial release
- ✅ KOReader sync support
- ✅ Kobo device support
- ✅ Web sync support - ✅ Web sync support
- ✅ KOReader sync (progress, bookmarks, highlights, notes)
- ✅ Conflict resolution - ✅ Conflict resolution
- ✅ Offline queue - ✅ Offline queue
- ✅ Real-time WebSocket sync - ✅ Real-time WebSocket sync
- 🚧 Native Kobo sync (coming soon)
- 🚧 Mobile apps (coming later)
--- ---
**Last Updated**: January 31, 2026 **Last Updated**: August 2026
**Version**: 1.0.0 **Version**: 1.0
**License**: MIT **License**: GPL-3.0
docs/user/user-guide.md
+5 -7
View File
@@ -6,18 +6,16 @@ Welcome to the Bookhoard user documentation. This section contains guides for us
Learn how to configure your e-reader devices to sync with Bookhoard: Learn how to configure your e-reader devices to sync with Bookhoard:
- **[Kobo Setup Guide](devices/kobo-setup.md)** - Complete guide for Kobo e-readers
- Device registration
- Sync configuration
- OPDS wireless book delivery
- Troubleshooting
- **[KOReader Setup Guide](devices/koreader-setup.md)** - Complete guide for KOReader - **[KOReader Setup Guide](devices/koreader-setup.md)** - Complete guide for KOReader
- Installation on Kindle/Kobo/PocketBook - Installation on Kindle/Kobo/PocketBook
- Sync setup - Plugin setup with server-side device approval
- Progress, bookmark, highlight, and note sync
- OPDS catalog access - OPDS catalog access
- Troubleshooting - Troubleshooting
- **[Kobo Setup Guide](devices/kobo-setup.md)** - Native Kobo sync (coming soon)
- In the meantime, KOReader works great on Kobo hardware
## 🔄 Sync Configuration ## 🔄 Sync Configuration
- **[Universal Sync Guide](sync-guide.md)** - Understanding and using sync features - **[Universal Sync Guide](sync-guide.md)** - Understanding and using sync features