John O'Keefe
393a00e8dd
Two structural changes, one owner-approved plan: - Move the admin guides out of docs/user/ into their own docs/admin/ area — admin-guide.md becomes the Administration section landing page (pinned first), and the 32-line admin-library-management.md stub becomes admin/libraries.md, which the admin-docs build-out rebuilds into the real Libraries page next. Retired URLs 301 via a new docRedirects map in the docs HTTP handler (checked before .md canonicalization so even .md spellings one-hop to the new clean URL); the two inbound links (docs index, user-guide front door) updated. - Sidebar direct items now sort by usabilityOrder — an explicit, per-section display order — instead of alphabetically: User Guide mirrors the 'Where to go' table on user-guide.md, Devices orders Android → KOReader → Kobo (alphabetically Kobo used to sort ahead of KOReader), and Administration pre-lists its planned pages so each lands in place as the admin build writes it. Unlisted docs fall back to alphabetical after the listed ones. Display-order only by construction: the URL-driven expand/highlight machinery keys on containsURL membership and never sees sort order — nav tests updated to pin the new orders plus a real-tree test (TestBuildNavigationUsabilityOrder) guarding all three sections.
48 lines
2.4 KiB
Markdown
48 lines
2.4 KiB
Markdown
# Bookhoard — start here
|
|
|
|
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.
|
|
|
|
The moving parts, in one breath:
|
|
|
|
- **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
|
|
|
|
## Where to go
|
|
|
|
| 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) |
|
|
|
|
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).
|
|
|
|
## A note on admins
|
|
|
|
Some screens (user management, server settings, library folders) are admin
|
|
territory; [Admin Guide](../admin/admin-guide.md) is the door, and the admin docs are
|
|
being expanded separately.
|
|
|
|
**Looking for developer documentation?** See the
|
|
[Developer Portal](../developer/development.md).
|