docs: testing map + generated endpoint index (#185) #186

Merged
timothy merged 2 commits from feat/185-docs-part2 into main 2026-07-08 07:52:31 +02:00
Owner

Onboarding docs part 2 (closes #185).

  • docs/testing.md — authoritative testing map (test projects + in-memory SQLite fixture, golden-file nets + never-set-ETV_UPDATE_GOLDENS rule, TZ-independence #24, run commands, per-PR gate). docs/contributing.md §8 shrunk to a pointer.
  • scripts/generate-endpoint-index.py + docs/endpoint-index.md — generated route→verb→operation→summary index grouped by tag (114 endpoints, 175 operations); hooked into scripts/update-openapi.sh so it regenerates with the spec and cannot go stale. Reproducible from the spec alone (no timestamp; idempotent).
  • docs/README.md — reading order updated; placeholder removed.

fixes #185

🤖 Generated with Claude Code

Onboarding docs part 2 (closes #185). - **docs/testing.md** — authoritative testing map (test projects + in-memory SQLite fixture, golden-file nets + never-set-ETV_UPDATE_GOLDENS rule, TZ-independence #24, run commands, per-PR gate). docs/contributing.md §8 shrunk to a pointer. - **scripts/generate-endpoint-index.py** + **docs/endpoint-index.md** — generated route→verb→operation→summary index grouped by tag (114 endpoints, 175 operations); hooked into scripts/update-openapi.sh so it regenerates with the spec and cannot go stale. Reproducible from the spec alone (no timestamp; idempotent). - **docs/README.md** — reading order updated; placeholder removed. fixes #185 🤖 Generated with [Claude Code](https://claude.com/claude-code)
timothy added 1 commit 2026-07-08 07:39:31 +02:00
docs: testing map + generated endpoint index (#185)
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 4m36s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 4m45s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
0290594f0b
Adds docs/testing.md as the authoritative testing map (consolidated
from docs/contributing.md §8, now shrunk to a pointer), and a
generated docs/endpoint-index.md via scripts/generate-endpoint-index.py
(hooked into scripts/update-openapi.sh). Updates docs/README.md's
reading order and removes the "still to come" placeholder.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
timothy added 1 commit 2026-07-08 07:42:40 +02:00
docs: guard endpoint-index regen on successful spec build (#185 review)
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 4m34s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 4m41s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
6902f559f0
Only run generate-endpoint-index.py if the GenerateOpenApiDocuments build
succeeded, so a failed build can't render docs/endpoint-index.md from a
stale/partial v1.json.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
timothy merged commit a7d3fc3055 into main 2026-07-08 07:52:31 +02:00
Sign in to join this conversation.