Kessinen/av1dae
1
0
Fork 0
Code Issues 11 Pull Requests Actions Packages Projects Releases Wiki Activity

Document the web UI, settings, and processing controls in the manuals #12

New Issue
Open
opened 2026-06-21 17:54:53 +00:00 by Kessinen · 0 comments
Kessinen commented 2026-06-21 17:54:53 +00:00
Owner
Copy Link
Copy Source

The manuals describe none of the web-era features. MANUAL.md, MANUAL.html, and SPEC.md predate all of it and would mislead a new reader (they wouldn't know the UI exists).

Missing / stale across the docs:

  • Web dashboard and the http_addr config option (status page, live progress, queue, recent events).
  • The /settings page + /api/settings: which values are DB-editable (encoding profiles, lp, OMDb key, log retention, delete-originals), config-as-seed / DB-wins model.
  • Processing controls: start/hold gate + AV1DAE_AUTOSTART (queue is HELD by default now), pause/resume the active encode, retry a failed file.
  • Queue total ETA.
  • The lp (SVT-AV1 thread cap) encoding knob.
  • SPEC.md gaps: webdl/tvrip encoding profiles are missing entirely; the overview/strings predate the av1dae rename; media-type token vs pixel-count detection is not documented.
  • A full /api endpoint reference (GET /status, GET|PUT /api/settings, POST /api/{start,hold,pause,resume,retry}).

Scope: refresh MANUAL.md and mirror into MANUAL.html; bring SPEC.md current. The #6 logging section is already done and can be left as-is.

The manuals describe none of the web-era features. MANUAL.md, MANUAL.html, and SPEC.md predate all of it and would mislead a new reader (they wouldn't know the UI exists). Missing / stale across the docs: - Web dashboard and the http_addr config option (status page, live progress, queue, recent events). - The /settings page + /api/settings: which values are DB-editable (encoding profiles, lp, OMDb key, log retention, delete-originals), config-as-seed / DB-wins model. - Processing controls: start/hold gate + AV1DAE_AUTOSTART (queue is HELD by default now), pause/resume the active encode, retry a failed file. - Queue total ETA. - The lp (SVT-AV1 thread cap) encoding knob. - SPEC.md gaps: webdl/tvrip encoding profiles are missing entirely; the overview/strings predate the av1dae rename; media-type token vs pixel-count detection is not documented. - A full /api endpoint reference (GET /status, GET|PUT /api/settings, POST /api/{start,hold,pause,resume,retry}). Scope: refresh MANUAL.md and mirror into MANUAL.html; bring SPEC.md current. The #6 logging section is already done and can be left as-is.
Kessinen added the documentation label 2026-06-21 17:54:53 +00:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
backlog
Deferred / not scheduled
 bug
Something is incorrect
 chore
Maintenance / housekeeping
 documentation
Docs and manual
 enhancement
New feature or request
 security
Auth, hardening, exposure
 ui
Web dashboard / UX
No labels documentation
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
Kessinen (Esa Kataja)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Kessinen/av1dae#12