docs(user): dashboard, browsing, profile rewrites + new podcasts guide; trash stubs
Ground-truthed against the templates this pass: - dashboard.md: real section kinds (system shelves incl. Continue Series, user collections, custom sections via /custom-section builder), Customize Dashboard panel semantics (per-library, drag, switches, 10-50 items, Save Changes), Refresh, This Week widget, per-item Read/Listen and progress-conflict resolve actions. The old page listed a wrong shelf set and never mentioned custom sections. - library-browsing.md: the file was secretly titled 'Saving Custom Filters' and covered nothing else. Now the browsing page: All Books toolbar (search, Sort, Filters -> drawer hand-off, Save/Load/Clear saved filters), book detail as hub, series pages, podcasts split. - profile-guide.md: field table ground-truthed from profile_form.templ (username/email DO remain editable there), audio defaults (speed, resume rewind, keep awake), timezone rendering contract, both theme doors (7-pick select vs 37-theme Appearance panel), Change Password with live checks, Danger Zone/Remove My Account + last-admin rule. - podcasts.md NEW: the Podcasts page had zero documentation. Subscribing (Add Feed -> RSS URL, library, back-catalog download, download order, Add & Subscribe), Continue/All Feeds, Download All, player + Play as Sequence cross-link. - Trashed user-areas.md, frontend-guide.md, settings-guide.md: stubs whose planned content now exists as real pages (or duplicates profile-guide). user-guide.md rewritten as the plain-language front door with a go-here-when table; index.md rows updated to match. - ui-controls.md: 10 new gate-checked entries for every newly cited control (Add & Subscribe via templ-entity fragment).
This commit is contained in:
1 parent
ceed3ddeae
commit
9e2f216af5
10 files changed
+244
-288
No files matched your search
+38
-70
@@ -1,79 +1,47 @@
|
||||
# User Documentation
|
||||
# Bookhoard — start here
|
||||
|
||||
Welcome to the Bookhoard user documentation. This section contains guides for using Bookhoard features, setting up devices, and configuring sync.
|
||||
Bookhoard is a self-hosted home for the things you read and hear: your book
|
||||
libraries live on your own server, you read them in the browser or on your
|
||||
devices, and everything keeps track of where you are.
|
||||
|
||||
## 📱 Device Setup
|
||||
The moving parts, in one breath:
|
||||
|
||||
Learn how to configure your e-reader devices to sync with Bookhoard:
|
||||
- **Libraries** hold your books (and your podcasts run as feeds of their own)
|
||||
- The **dashboard** is your home screen — shelves that update themselves
|
||||
- **Collections** are shelves you build, by hand or by rules
|
||||
- **Filters** answer "which books match?" — the same rules power saved
|
||||
filters, smart collections, and dashboard shelves
|
||||
- **Devices** — the Android app, KOReader on e-readers, and stock Kobo
|
||||
firmware — stay in step with the server through **sync**
|
||||
- Your **profile** holds your preferences: theme, playback defaults, password
|
||||
|
||||
- **[Android App Guide](devices/android-app.md)** - The native Android client
|
||||
- Installing and upgrading the APK
|
||||
- Connecting to a self-hosted server over LAN
|
||||
- The Android 16+ local-network permission
|
||||
- Troubleshooting login failures
|
||||
## Where to go
|
||||
|
||||
- **[KOReader Setup Guide](devices/koreader-setup.md)** - 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
|
||||
| You want to... | Read |
|
||||
| --- | --- |
|
||||
| Learn the layout: dashboard, shelves, customizing | [Dashboard](dashboard.md) |
|
||||
| Browse, search, and sort your books | [Browsing your library](library-browsing.md) |
|
||||
| Build shelves — by hand or with rules | [Collections](collections.md) |
|
||||
| Narrow with rules, save them, reuse them | [Filters — the complete guide](filters/index.md) |
|
||||
| Subscribe to shows, download, listen | [Podcasts](podcasts.md) |
|
||||
| Read and annotate in the browser | [Web Reader Guide](reader-guide.md) |
|
||||
| Change themes and bookshelf textures | [Themes and Wood Paneling](themes.md) |
|
||||
| Edit your account, password, playback defaults | [Your profile](profile-guide.md) |
|
||||
| Get the Android app talking to your server | [Android App](devices/android-app.md) |
|
||||
| Use KOReader on an e-reader | [KOReader Setup](devices/koreader-setup.md) |
|
||||
| Use a Kobo | [Kobo Setup](devices/kobo-setup.md) |
|
||||
| Understand how it all stays in sync | [Universal Sync Guide](sync-guide.md) |
|
||||
| Import from Calibre | [Calibre Integration](calibre-integration.md) |
|
||||
|
||||
- **[Kobo Setup Guide](devices/kobo-setup.md)** - Native Kobo sync (coming soon)
|
||||
- In the meantime, KOReader works great on Kobo hardware
|
||||
New here? The usual path is: browse [your library](library-browsing.md),
|
||||
open a book, and let the [dashboard](dashboard.md) keep track of you. Sync
|
||||
comes when you add a [device](devices/android-app.md).
|
||||
|
||||
## 🔄 Sync Configuration
|
||||
## A note on admins
|
||||
|
||||
- **[Universal Sync Guide](sync-guide.md)** - Understanding and using sync features
|
||||
- What is Universal Sync?
|
||||
- Supported devices
|
||||
- Book matching and auto-linking
|
||||
- Conflict resolution
|
||||
- Best practices
|
||||
Some screens (user management, server settings, library folders) are admin
|
||||
territory; [Admin Guide](admin-guide.md) is the door, and the admin docs are
|
||||
being expanded separately.
|
||||
|
||||
## 📚 Calibre Integration
|
||||
|
||||
- **[Calibre Integration Guide](calibre-integration.md)** - 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
|
||||
|
||||
## 📖 Reading
|
||||
|
||||
- **[Web Reader Guide](reader-guide.md)** - Reading and annotating in the browser
|
||||
- Touch navigation (swipe to page, tap for menu)
|
||||
- Selecting text: long-press, drag, handles
|
||||
- Highlights, notes, copy, and editing
|
||||
- PDFs and comics
|
||||
|
||||
## 🎨 Frontend Guide
|
||||
|
||||
**[Frontend Guide](frontend-guide.md)** - Learn how to use the Bookhoard web interface
|
||||
|
||||
- _Coming Soon_
|
||||
|
||||
## 👤 User Areas
|
||||
|
||||
**[User Areas Guide](user-areas.md)** - Managing your personal library and settings
|
||||
|
||||
- _Coming Soon_
|
||||
|
||||
## ⚙️ Settings
|
||||
|
||||
**[Settings Guide](settings-guide.md)** - Configuring your Bookhoard preferences
|
||||
|
||||
- _Coming Soon_
|
||||
|
||||
## 🔐 Admin Features
|
||||
|
||||
**[Admin Guide](admin-guide.md)** - Administrative functions and management
|
||||
|
||||
- _Coming Soon_
|
||||
|
||||
---
|
||||
|
||||
**Looking for developer documentation?** See the [Developer Portal](../developer/development.md)
|
||||
**Looking for developer documentation?** See the
|
||||
[Developer Portal](../developer/development.md).
|
||||
Reference in new issue
Block a user