Updating docs to include new Controller onboarding flow, certificates, and video captions.

This commit is contained in:
rolobio 2026-03-22 19:47:03 -06:00
parent f8164d9053
commit d2415ae19f
11 changed files with 142 additions and 24 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

View file

@ -0,0 +1,76 @@
# Docs
## Overview
The Docs module provides a unified interface for viewing, organizing, and searching documents. The main page
(`/docs`) allows browsing all documents with filtering and search.
![docs-page.png](docs-page.png)
## Supported Formats
The Docs module supports the following file types:
* **eBooks** - EPUB, MOBI
* **PDFs** - PDF
* **Office Documents** - DOCX, DOC, ODT
* **Comic Books** - CBZ, CBR, CBT, CB7
## Browsing Documents
The Docs page displays all documents sorted by published date by default. You can change the sort order to:
* **Published Date** - When the document was published
* **Size** - File size
* **Title** - Alphabetical by title
When using search, results are sorted by relevance.
## Inline Viewers
Documents can be read directly in the browser without downloading:
* **EPUB** - A built-in HTML5 reader renders EPUB files.
* **PDF** - An embedded PDF viewer displays the document.
* **Comic Books** - A dedicated comic viewer displays pages with navigation controls, keyboard shortcuts
(arrow keys), and a right-to-left mode toggle for manga.
![docs-detail.png](docs-detail.png)
## Authors and Subjects
The Docs module automatically creates collections for authors and subjects extracted from document metadata.
* **Authors** (`/docs/authors`) - Browse documents grouped by author.
* **Subjects** (`/docs/subjects`) - Browse documents grouped by subject.
Clicking an author or subject name filters the document list to show only matching documents.
## Searching
Documents are searchable using full-text search across their content and metadata. You can also filter by:
* Author
* Subject
* Language
* File type
* Tags
When indexes for a document are generated, they are searched in the following order of precedence:
1. Title
2. Author
3. Document contents
## Cover Images
The Docs module automatically extracts or detects cover images:
* Calibre ebook directories with a `cover.jpg`
* Cover images embedded in EPUB metadata
* First page of PDFs
## Statistics
The statistics page (`/docs/statistics`) provides an overview of your document library including total document
count, format breakdown, total size, and unique author and subject counts.

View file

@ -169,6 +169,24 @@ When the indexes for a Video are generated for searching, they are searched in t
2. Description
3. Subtitles
## Captions
When a video has captions (VTT or SRT files), they are displayed in the **Captions** tab on the video detail page.
You can click the timestamp to scrub the video to that location.
![video-captions.png](video-captions.png)
### Scrubbing by Caption
Each caption line has a clickable timestamp link on the left side. Clicking a timestamp will jump the video to
that point, making it easy to navigate long videos by their spoken content.
### Filtering Captions
A filter input at the top of the captions tab allows you to search through the caption text. Type one or more
words to narrow the list to only captions containing all of those words. This is useful for finding a specific
topic or quote in a long video.
## Videos without WROLPi
WROLPi comes with VLC pre-installed, this application allows you to watch video files, even if the React App is not

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB