diff --git a/docs/user/admin-library-management.md b/docs/user/admin-library-management.md index a00bf08..dc741ab 100644 --- a/docs/user/admin-library-management.md +++ b/docs/user/admin-library-management.md @@ -8,12 +8,12 @@ When creating or managing a library, you can add folders containing your media f The admin library page includes a folder browser to help you select folders on the server: -1. Navigate to **Admin → Library Management** -2. Find the library you want to manage -3. Click the **Folders** button -4. Click **Browse** next to "Add folder path" +1. Open the **Administration** panel in the sidebar (admins only) and go to **Libraries** +2. Click a library in the list to expand its panel +3. Find the **Folders** section +4. Click **Browse** next to the folder path input — this opens the **Browse Folders** dialog 5. Navigate through the server's filesystem -6. Select a folder by clicking **Select This Folder** +6. Select a folder; it fills the path input, then click **Add** ### Security diff --git a/docs/user/calibre-integration.md b/docs/user/calibre-integration.md index 30f29ad..1c3fcf0 100644 --- a/docs/user/calibre-integration.md +++ b/docs/user/calibre-integration.md @@ -58,20 +58,22 @@ Calibre Library/ ### Step 2: Add Library in Bookhoard -1. Navigate to **Admin** → **Libraries** -2. Click **Add Library** +1. Open the **Administration** panel in the sidebar and go to **Libraries** +2. Click **Create Library** 3. Configure: - - **Name**: "My Calibre Library" - - **Type**: Ebook (or Audiobook/Comic) - - **Folder**: Path to your Calibre library - - **Scan on save**: ✅ Checked -4. Click **Save** + - **Library Name**: "My Calibre Library" + - **Description**: Optional + - **Library Type**: Ebook (or Audiobook/Comic) +4. Click the library in the list to expand its panel +5. Add your Calibre library folder in the **Folders** section: + - Enter the path (or click **Browse** to find it on the server) and click **Add** +6. Trigger a scan (see below), or rely on watch mode if enabled -Bookhoard will automatically scan the library and import all books with their Calibre metadata. +Bookhoard scans the library and imports all books with their Calibre metadata. Scan progress shows in the sidebar next to the logo. ### Step 3: Verify Import -1. Navigate to **Library** view +1. Open the **Dashboard** or **All Books** page (sidebar navigation) 2. Browse your imported books 3. Check that: - Titles and authors are correct @@ -136,8 +138,8 @@ As long as a `metadata.opf` file exists in the folder, Bookhoard will import the **Scenario**: You have a Calibre library with 500 ebooks, all organized with series, tags, and custom covers. **Steps**: -1. Add the Calibre library folder in Bookhoard -2. Enable "Scan on save" +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) 3. Bookhoard imports all 500 books with: - Correct titles and authors - Series information (e.g., "Harry Potter #2") @@ -166,9 +168,8 @@ 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: - - Navigate to **Admin** → **Libraries** - - Click **Rescan** on your library - - Or use the **Scanner API** to force rescan + - Via the **Scanner API** (`POST /api/scanner/scan`), 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 **Result**: Bookhoard reflects your Calibre changes automatically. @@ -182,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**: Use the "Force Rescan" option to re-import all metadata +3. **Force rescan**: Trigger a scan via the Scanner API to re-import all metadata (watch mode also picks up changed files automatically) 4. **Check logs**: Review Bookhoard logs for parsing errors ### Incorrect Metadata @@ -219,7 +220,7 @@ As long as a `metadata.opf` file exists in the folder, Bookhoard will import the **Do**: - ✅ Edit metadata in Calibre -- ✅ Rescan in Bookhoard to sync changes +- ✅ Let Bookhoard's next scan (or watch mode) pick up the changes - ✅ Use Calibre for library management **Don't**: diff --git a/docs/user/collections.md b/docs/user/collections.md index 0e7df39..81418f7 100644 --- a/docs/user/collections.md +++ b/docs/user/collections.md @@ -6,7 +6,7 @@ Collections allow you to organize books across multiple libraries. ### From Collections Page -Navigate to `/collections` to see all your collections. Clicking on a collection shows ALL books in that collection across all libraries. +Navigate to **Collections** (sidebar navigation) to see all your collections. Clicking on a collection shows ALL books in that collection across all libraries. ### From Dashboard @@ -19,8 +19,24 @@ When viewing a specific library's dashboard, collections only show books from th ## Creating Collections -[Instructions for creating collections] +1. Go to **Collections** (sidebar navigation) +2. Click **New Collection** (top-right) — or **Create Your First Collection** if the list is empty +3. Fill in the details: + - **Name** - Collection name + - **Description** - Optional description + - **Icon** - Pick from the icon grid + - **Color** - Pick a color swatch +4. Click **Create Collection** ## Managing Collections -[Instructions for editing/deleting collections] +Each collection in the list has icon buttons on its card: + +- **Edit** - Opens the edit form to change name, description, icon, or color. Click **Update Collection** to save. +- **Delete** - Removes the collection after a confirmation prompt. + +Deleted a system collection by mistake? The **Restore System** button on the Collections page brings back system collections. + +### Dashboard Sections + +Collections appear as sections on your dashboard. Show, hide, and reorder them from the dashboard's **Customize Dashboard** settings (see [Dashboard](dashboard.md)).