Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 3.81 KB

File metadata and controls

61 lines (41 loc) · 3.81 KB
id docs-gaps
type reference
status stable
tags
documentation
gaps
opportunities

Documentation gaps

Known missing or incomplete documentation. Address these when touching the relevant area or in a dedicated docs pass. See also memory-bank/opportunities.md for improvement backlog.


Critical (blocks or misleads users)

(None at this time — revalidated 2026-03-22 after station-ops/runtime and command-surface doc audit.)


High (users or contributors need this)

(None — revalidated 2026-03-22. Hand-maintained commands/flags/env: cli-and-env-reference; exhaustive raw list: .env.example.)


Medium (improves clarity or onboarding)

(None — revalidated 2026-03-22. architecture includes a Mermaid flowchart under Visual (Mermaid) alongside the ASCII diagram.)


Low (nice to have)

(None — revalidated 2026-03-22. glossary defines core terms; runbooks + iptvtunerr-troubleshooting cover common failures; deployment §§1–3 covers binary run vs index/serve, Docker Compose/docker run overrides, and systemd.)


Resolved (documentation)

Closed What Link
2026-03 Single-place env documentation (supersedes “only .env.example”) Canonical operator map: cli-and-env-reference; reference index; README quick table
2026-03 Architecture overview (“no architecture doc”) explanations/architecture.md — three layers, data flow, package map
2026-03 Mermaid diagram (optional polish on architecture doc) architecture.md § Visual (Mermaid)
2026-03 VODFS mount / cache / Plex libraries mount-vodfs-and-register-plex-libraries.md
2026-03 External XMLTV + layered guide pipeline features §5; lineup-epg-hygiene; glossary XMLTV
2026-03 Multi-host / Cloudflare operator guidance cloudflare-bypass.md; interpreting-probe-results
2026-03 Run vs index/serve deployment §1
2026-03 Glossary glossary.md
2026-03 Runbooks / common failures runbooks index; iptvtunerr-troubleshooting
2026-03 Docker / systemd deployment deployment §2–3
2026-03 Plex setup paths (wizard vs -register-plex vs API; channelmap, 480 limit, empty guide) connect-plex-to-iptv-tunerr.md; see also plex-dvr-lifecycle-and-api
2026-03 Operator harness how-tos (task-oriented entrypoints mirroring runbook §7 / §9 / §10) live-race-harness.md, stream-compare-harness.md, multi-stream-harness.md
2026-03 probe output interpretation interpreting-probe-results.md; scripts/harness-index.py lists recent .diag/ harness runs

Maintenance

  • When closing a gap, move its row to a "Resolved" subsection with date and link to the new doc.
  • New gaps: add under the appropriate severity; prefer one row per gap with "Suggested fix" so the next writer can act.