docs(user): sync-guide rebuild to today's platform; calibre guide de-API'd
sync-guide.md was 591 lines with good implementation-derived bones (matching confidence table, universal locations, conflict flow) wrapped around a stale device story: Android 'coming later' (the app exists and self-registers), a deleted queue UI, invented UI (color status badges, Auto-Resolve Future, Priority Sync buttons), placeholder support links, an HTTPS-1.3 overclaim on LAN setups that are plain HTTP by design, and a changelog promising the future. Rebuilt to ~140 lines, every claim grounded: device table matches reality (web/Android/KOReader supported, Kobo native server-complete with rollout pending), resolution strategies as the API actually defines them (device / server / highest_progress), offline queuing honestly scoped (Android queues; server holds per-device queue; no dedicated queue UI today), reading history on Progress page, RLS-era privacy wording, device limit 10 default admin-settable. Reader Sync Progress button verified. calibre-integration.md: mostly current (sidecar-first model, Dublin Core tables, Write-to-file section all kept); fixed the user-hostile 'POST /api/scanner/scan' instructions to point at the admin scan controls, and dropped the yourusername placeholder repo links.
This commit is contained in:
1 parent
c1a7648076
commit
12aab156f6
2 files changed
+102
-560
No files matched your search
@@ -139,7 +139,7 @@ As long as a `metadata.opf` file exists in the folder, Bookhoard will import the
|
||||
|
||||
**Steps**:
|
||||
1. Add the Calibre library folder in Bookhoard (Administration → Libraries → expand the library → **Folders**)
|
||||
2. Trigger a scan via the **Scanner API**, or let watch mode pick up the changed files (the File Watcher status is shown on the admin dashboard)
|
||||
2. Trigger a scan from the admin interface's scan controls, or let watch mode pick up the changed files automatically
|
||||
3. Bookhoard imports all 500 books with:
|
||||
- Correct titles and authors
|
||||
- Series information (e.g., "Harry Potter #2")
|
||||
@@ -168,7 +168,7 @@ As long as a `metadata.opf` file exists in the folder, Bookhoard will import the
|
||||
**Steps**:
|
||||
1. Edit metadata in Calibre (it updates `metadata.opf`)
|
||||
2. In Bookhoard, trigger a rescan:
|
||||
- Via the **Scanner API** (`POST /api/scanner/scan`), or
|
||||
- Via the admin interface's scan controls, or
|
||||
- Let watch mode detect the changed files automatically (see File Watcher on the admin dashboard)
|
||||
3. Bookhoard detects updated `metadata.opf` and refreshes metadata
|
||||
|
||||
@@ -183,7 +183,7 @@ As long as a `metadata.opf` file exists in the folder, Bookhoard will import the
|
||||
**Solutions**:
|
||||
1. **Check file structure**: Ensure `metadata.opf` is in the same folder as the book file
|
||||
2. **Verify library type**: Ensure library type matches content (ebook vs. audiobook)
|
||||
3. **Force rescan**: Trigger a scan via the Scanner API to re-import all metadata (watch mode also picks up changed files automatically)
|
||||
3. **Force rescan**: Trigger a rescan from the admin interface to re-import all metadata (watch mode also picks up changed files automatically)
|
||||
4. **Check logs**: Review Bookhoard logs for parsing errors
|
||||
|
||||
### Incorrect Metadata
|
||||
@@ -332,11 +332,10 @@ file is never touched if anything fails (temp file + atomic rename).
|
||||
- [Calibre Website](https://calibre-ebook.com/)
|
||||
- [Calibre User Manual](https://manual.calibre-ebook.com/)
|
||||
- [Calibre Forum](https://www.mobileread.com/forums/forumdisplay.php?f=166)
|
||||
- [Bookhoard GitHub](https://github.com/yourusername/bookhoard)
|
||||
|
||||
## Need Help?
|
||||
|
||||
- **Documentation**: See [User Guide](user-guide.md) for general Bookhoard usage
|
||||
- **Troubleshooting**: See [Operations Guide](../operations/operations.md) for common issues
|
||||
- **Developer Docs**: See [Developer Portal](../developer/development.md) for technical details
|
||||
- **Issues**: Report bugs or request features on [GitHub Issues](https://github.com/yourusername/bookhoard/issues)
|
||||
- **Issues**: Report bugs or request features on your repository's issue tracker
|
||||
Reference in new issue
Block a user