Updated docs and closing #23

2026-01-20 19:01:11 +01:00
parent 8654289ad5
commit 276676b181
3 changed files with 61 additions and 5 deletions
@@ -93,4 +93,31 @@ PRECACHE_THUMBS: "true"         # Generate thumbs when manual reindex is trigger
 ENABLE_WATCH: "true"            # Auto-update index on file changes
 ```

-This gives you the fastest startup time and lets you trigger heavy operations only when needed via the dashboard buttons.
+This gives you the fastest startup time and lets you trigger heavy operations only when needed via the dashboard buttons.
+
+### SSD Optimization
+
+For optimal performance, certain `/data` subdirectories benefit significantly from being stored on SSD:
+
+#### Recommended for SSD
+- `/data/thumbs` - Thumbnail cache (frequently accessed during browsing)
+- `/data/pages` - Page cache for streaming (frequently accessed during reading)
+- `/data/library.db` - SQLite database (all queries access this)
+
+#### Can Stay on HDD
+- `/data/smartlist.json` - Smart list configuration (small, rarely accessed)
+
+#### Docker Volume Mapping Example
+
+To split storage between SSD and HDD:
+
+```yaml
+volumes:
+  - /path/to/hdd/comicopds:/data                    # Main config on HDD
+  - /path/to/ssd/comicopds/thumbs:/data/thumbs      # Thumbnails on SSD
+  - /path/to/ssd/comicopds/pages:/data/pages        # Page cache on SSD
+  - /path/to/ssd/comicopds/library.db:/data/library.db  # Database on SSD
+  - /path/to/your/comics:/library:ro                # Comic library (read-only)
+```
+
+This setup keeps configuration files on regular storage while placing performance-critical caches and the database on faster SSD storage.
@@ -10,7 +10,7 @@ ComicOPDS provides powerful search capabilities:

 ### Searchable Fields
 - `series` - Comic series name
- `title` - Individual issue title  
+- `title` - Individual issue title
 - `publisher` - Publishing company
 - `year` - Publication year
 - `writer` - Writer(s)
@@ -18,7 +18,7 @@ ComicOPDS provides powerful search capabilities:
 - `genre` - Comic genre/category
 - `characters` - Featured characters
 - `tags` - Custom tags
- `format` - TPB, Main Series, Annual, One-Shot etc. 
+- `format` - TPB, Main Series, Annual, One-Shot etc.

 ### Search Tips
 - Use quotes for exact phrases: `"Dark Knight"`
@@ -97,6 +97,12 @@ For advanced users, Smart Lists are stored in `/data/smartlist.json`:
  - limit: 0 
  - Distinct: no

+### Supported Fields
+
+All metadata fields from ComicInfo.xml plus:
+- `filename` - File name (useful for custom naming schemes, e.g., `filename contains "[R]"` for read status)
+- `name` - Same as filename
+
 ### Supported Operations
 - `equals`, `contains`, `startswith`, `endswith`
 - `=`, `!=`, `>=`, `<=`, `>`, `<` (for numeric fields)
@@ -134,16 +140,39 @@ So you get a de-duplicated "what's the newest issue for each series?" view.

 Dynamic Smart Lists automatically create sub-folders based on distinct values in a metadata field. Instead of manually creating one smart list per writer, publisher, or series, you can create a single dynamic smart list that generates them automatically.

+**This feature provides folder/stack view within smart lists** - perfect for organizing search results by series, writer, publisher, or any other field.
+
 #### How It Works

-When you set the **Group By** field to a metadata field (e.g., `writer`, `publisher`, `format`):
+When you set the **Group By** field to a metadata field (e.g., `series`, `writer`, `publisher`, `format`):

 1. The smart list becomes a navigation folder showing all distinct values for that field
-2. Each value appears as a sub-folder with a count (e.g., "Brian K. Vaughan (47)")
+2. Each value appears as a sub-folder with a count (e.g., "Batman (1940)" (127), "Batman vs. Dracula" (4))
 3. Clicking a sub-folder shows all comics matching both:
   - Your smart list filters (if any)
   - That specific field value

+#### Example: Browse Batman Comics by Series
+
+Instead of getting a long flat list of all Batman issues, you can create a grouped view:
+
+Create a smart list named "Batman Comics":
+- **Group By**: `series`
+- **Rules**: `series contains "Batman"`
+- **Sort**: `series_number`
+
+Result: You get folder/stack view like:
+```
+Batman Comics/
+  ├── Batman (1940) (387)
+  ├── Batman and Robin (2009) (26)
+  ├── Batman vs. Dracula (4)
+  ├── Batman: The Dark Knight (2011) (29)
+  └── ...
+```
+
+Clicking into "Batman (1940)" shows all 387 issues sorted by number.
+
 #### Example: Browse by Writer

 Create a smart list named "All Writers":