test(docs): check that doc links, commands and flags exist - #74
Open
scott-lowe-vapi wants to merge 1 commit into
Open
scott-lowe-vapi wants to merge 1 commit into
scott-lowe-vapi wants to merge 1 commit into
Conversation
The README now links into eight guides that link to each other, and the docs name many commands and flags. Nothing checked either: renaming a heading, a script or a flag would leave the docs quietly wrong. - tests/docs-links.test.ts: every relative link and #anchor in the root markdown files, docs/ and examples/ resolves (GitHub's heading anchor rules, code blocks ignored). - tests/docs-commands.test.ts: every `npm run <x>` in the docs is a package.json script, and every documented --flag (after `npm run` on the same line, or on its own in inline code) appears in src/. Flags of other tools are allow-listed, and improvements.md is skipped as a historical log. Each test fails when a heading, a script or a flag is renamed (checked by breaking one of each). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This was referenced Oct 3, 2026
Contributor
Author
This was referenced Oct 3, 2026
scott-lowe-vapi
marked this pull request as ready for review
October 3, 2026 07:20
This was referenced Oct 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Value
V.A.L.U.E. tier: micro — tests only; 2 new test files; no blast-radius path; the tests are the deterministic check.
npm run <script>,--flag) from shipping.tests/docs-links.test.ts: every relative link and#anchorin the root*.md,docs/**andexamples/**must resolve, ignoring code blocks.tests/docs-commands.test.ts: everynpm run <x>in the docs must be apackage.jsonscript, and every--flagshown with a command must exist insrc/.improvements.mdis excluded because it records historical behavior;--allow-unrelated-historiesis allowed as a git flag.Evidence of value
package.jsonscriptsrc/Testing plan
npm test(505 tests at this commit) andnpx tsc --noEmitpass.https://links, which would make the suite network-dependent.Refs TEST-141
🤖 Generated with Claude Code