Skip to content

Commit 76627fa

Browse files
docs: add docs/ index page linking the CLI guide and design docs
There was no landing page for the docs/ folder. Add docs/README.md (which GitHub renders as the folder front page) with a one-line description of each doc, including the new CLI guide. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 2a305c2 commit 76627fa

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Programmarr docs
2+
3+
Start at the [project README](../README.md) for install + quick start. These docs go deeper.
4+
5+
| Doc | What it covers |
6+
|-----|----------------|
7+
| [cli.md](cli.md) | **Run Programmarr from the terminal** — no Docker. Interactive menu, raw scripts (cron-friendly), and editing `config.json` by hand. |
8+
| [api.md](api.md) | Backend HTTP endpoint reference (Pipeline / Recipe / Tunarr / TMDB / Plex). |
9+
| [live-channels-design.md](live-channels-design.md) | How auto-updating "live" channels work — scheduler, in-place updates, rationale. |
10+
| [tunarr-commercials-findings.md](tunarr-commercials-findings.md) | What does and doesn't work for commercials/filler in Tunarr (QSV mid-roll caveat). |
11+
| [ideas.md](ideas.md) | Planned/unbuilt ideas — not yet in the product. |

0 commit comments

Comments
 (0)