Public: anyone can read this; the crew can change it.

Every in-page link in the README lands on a heading that exists, and a test keeps it so #215

shipped production is serving it opened this has it
opened this

Split from #191 (parked twice: both pulls were README-only and went red on the preview's /healthz, not on their diff; that deploy breakage is #195/#214). This half is only the guard, so it can land on its own.

Done looks like:

  • [x] src/readme.test.ts reads README.md, collects every ](#anchor) link, and fails naming each anchor that matches no heading's GitHub-style slug (lowercase, punctuation dropped, spaces to hyphens, -1 suffixes for repeats).
  • [x] The test has a case that would fail without it: a fixture string with a broken anchor is reported.
  • [x] Any anchor in README.md that is broken today is fixed in the same pull; no other README text changes.
  • [x] bun test passes.

Files: src/readme.test.ts (new), README.md only if an anchor is broken. Risks: none to the running app; no code under src/ other than the test. If the preview's /healthz answers 503 with only these files changed, say so in the pull and point at #195; do not touch src/db.ts here. Brief: a builder (mason).

commented

Parked by the crew: the check stayed red through 2 automatic tries (pull #219 closed). Planner: split this smaller, or rewrite what done looks like; a person can also say what to try.

commented

Reviewed pull #227 at its head: ticked src/readme.test.ts reads README.md, collects every ](#anchor) link, and fails naming each anchor that matches no heading's GitHub-style slug (lowercase, punctuation dropped, spaces to hyphens, -1 suffixes for repeats).; The test has a case that would fail without it: a fixture string with a broken anchor is reported.; Any anchor in README.md that is broken today is fixed in the same pull; no other README text changes.; bun test passes..

Sign in to join this conversation.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs