John O'Keefe
913174cdf8
TestDocsRelativeLinks walked only docs/developer; widening it to all of docs/ immediately surfaced the same class of rot the gate was built for, outside its old reach: - docs/index.md was the old monolith's landing page: linked the deleted api-reference.md, 10 directory-style area links, and escaped the docs tree to README/AGENTS/.env/compose. Rewritten as a portal whose every link resolves, with one representative endpoint doc per API area and pointers to the new writing-ui-docs.md standard. - directory-style links in user stubs (devices/, ../operations/) - case-mismatched links (Development.md) in contributing.md - monolith-era pointer (API_REFERENCE.md, TROUBLESHOOTING.md) and escaped AGENTS.md links in contributing/development.md - docs/development/calibre-opf-implementation.md double-up escapes, a link to the removed repo-root plan file (absorbed here), and a source-code hyperlink the docs site can't serve (now inline code) - operations/operations.md linked three never-written guide pages as aspirational links - they stay plain text until pages exist HANDS-OFF (project owner, 2026-11-02): docs/user/filters/** and docs/user/searching-and-filtering.md are exempt as link sources so no future checker failure can force edits to the filter documentation. Files linking INTO them remain checked.
43 lines
1.8 KiB
Markdown
43 lines
1.8 KiB
Markdown
# Kobo Device Setup Guide
|
|
|
|
> ## 🚧 Coming Soon
|
|
>
|
|
> Native Kobo sync is not available yet. It is actively being developed and this guide will be filled in as the feature lands.
|
|
|
|
## Using a Kobo With Bookhoard Today
|
|
|
|
You don't have to wait: **KOReader runs on Kobo hardware** and syncs fully with Bookhoard today — reading position, bookmarks, highlights, and notes, plus OPDS wireless book delivery.
|
|
|
|
See the **[KOReader Setup Guide](koreader-setup.md)** for complete instructions.
|
|
|
|
## What's Planned for Native Kobo Sync
|
|
|
|
When released, native Kobo sync will let stock Kobo firmware talk directly to Bookhoard:
|
|
|
|
- **Reading position sync** — percentages, pages, and reading statistics
|
|
- **Bookmarks, highlights, and notes** — synced with the web and other devices
|
|
- **OPDS wireless delivery** — browse and download books directly on the Kobo
|
|
- **Automatic EPUB → KEPUB conversion** — for better Kobo rendering
|
|
- **Shelf mappings** — Bookhoard collections appearing as Kobo shelves
|
|
|
|
The server-side protocol endpoints are already implemented and under test; the feature will be announced when it's ready for real devices.
|
|
|
|
## FAQ
|
|
|
|
**Q: Should I buy a Kobo to use with Bookhoard today?**
|
|
A: Kobo devices work great with Bookhoard via KOReader. Native (stock firmware) sync is coming soon.
|
|
|
|
**Q: What happens to my KOReader setup when native sync arrives?**
|
|
A: Nothing — KOReader will keep working. Native sync simply adds another option for people who prefer stock Kobo firmware.
|
|
|
|
## Additional Resources
|
|
|
|
- [KOReader Setup Guide](koreader-setup.md) — works on Kobo today
|
|
- [Bookhoard Universal Sync Guide](../sync-guide.md)
|
|
- Kobo sync protocol (for developers): [Kobo API docs](../../developer/api/kobo/sync_from_server.md)
|
|
|
|
---
|
|
|
|
**Last Updated**: August 2026
|
|
**Bookhoard Version**: 1.0
|