From e310fa6a9df54891949234437d9b4bcdf9d1f1f9 Mon Sep 17 00:00:00 2001 From: John O'Keefe Date: Thu, 20 Aug 2026 14:14:55 -0400 Subject: [PATCH] docs(index): update device guidance and fix broken links - Device setup and quick-find entries now lead with the KOReader guide and label native Kobo sync as coming soon - Kobo protocol/API listings tagged as a coming-soon feature - Fix seven pre-existing broken links: contributing/Development.md had the wrong case (development.md), and PROJECT_GUIDELINES.md links were missing the ../ prefix to reach the repo root - Refresh last-updated stamp --- docs/index.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/index.md b/docs/index.md index c1d80bf..b841e0d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,8 +11,8 @@ Complete guide to Bookhoard documentation. Find what you need quickly. **[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 + - [KOReader Setup Guide](user/devices/koreader-setup.md) - KOReader on Kindle/Kobo/PocketBook hardware + - [Kobo Setup Guide](user/devices/kobo-setup.md) - Native Kobo sync (coming soon; use KOReader today) - **Sync Configuration** - [Universal Sync Guide](user/sync-guide.md) - Understanding sync, book matching, conflicts @@ -38,12 +38,12 @@ Complete guide to Bookhoard documentation. Find what you need quickly. - [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 + - [Kobo API](developer/api/kobo/) - Kobo sync protocol endpoints (feature coming soon) - [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 + - [Kobo Sync Protocol](developer/api/sync/kobo-protocol.md) - Kobo device sync (coming soon) - [WebSocket API](developer/websocket-api.md) - Real-time events ### 🔧 For Operations @@ -62,8 +62,8 @@ Complete guide to Bookhoard documentation. Find what you need quickly. **[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 +- [Development Guide](contributing/development.md) - Architecture, setup, testing +- [../PROJECT_GUIDELINES.md](../PROJECT_GUIDELINES.md) - Development rules and standards --- @@ -75,7 +75,7 @@ Complete guide to Bookhoard documentation. Find what you need quickly. | **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) | +| **Contribute code** | [Contributing Portal → Development Guide](contributing/development.md) | | **Understand sync** | [User Portal → Sync Guide](user/sync-guide.md) | --- @@ -87,13 +87,13 @@ Complete guide to Bookhoard documentation. Find what you need quickly. | 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) | +| ...use a Kobo? | [Kobo Setup Guide](user/devices/kobo-setup.md) - native sync coming soon; KOReader works today | | ...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) | +| ...contribute code? | [Development Guide](contributing/development.md) | ### "Where is..." @@ -112,7 +112,7 @@ Complete guide to Bookhoard documentation. Find what you need quickly. ### Set up a new device -1. Choose your device: [Kobo](user/devices/kobo-setup.md) or [KOReader](user/devices/koreader-setup.md) +1. Choose your device: [KOReader](user/devices/koreader-setup.md) (works on Kindle, Kobo, and PocketBook hardware) 2. Understand sync: [Sync Guide](user/sync-guide.md) 3. Troubleshoot: Device-specific guides @@ -128,7 +128,7 @@ Complete guide to Bookhoard documentation. Find what you need quickly. 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 +4. Check [Development Guide](contributing/development.md) for performance tuning --- @@ -138,12 +138,12 @@ 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) +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. +Keep [../PROJECT_GUIDELINES.md](../PROJECT_GUIDELINES.md) in mind for documentation standards. --- -**Last Updated**: 2026-02-08 +**Last Updated**: August 2026 **Bookhoard Version**: 1.0