Add CI: automated doc-consistency checks - #65
Merged
Merged
Conversation
There's no automated test suite for this project's actual behavior (per
CLAUDE.md, that still requires running /create-dev-loop against a real
repo), but two of CLAUDE.md's hard rules were previously enforced only
by eye: every {{placeholder}} in the template needs a Step 4
substitution-table row, and README's "What it does" list must stay 1:1
with create-dev-loop.md's Steps. scripts/check_docs.py enforces both
mechanically, plus checks that relative links between the repo's own
docs resolve. Wired into .github/workflows/ci.yml on push/PR to main.
This was referenced Jul 27, 2026
Merged
Merged
Closed
dmccoystephenson
added a commit
that referenced
this pull request
Aug 3, 2026
There's no automated test suite for this project's actual behavior (per
CLAUDE.md, that still requires running /create-dev-loop against a real
repo), but two of CLAUDE.md's hard rules were previously enforced only
by eye: every {{placeholder}} in the template needs a Step 4
substitution-table row, and README's "What it does" list must stay 1:1
with create-dev-loop.md's Steps. scripts/check_docs.py enforces both
mechanically, plus checks that relative links between the repo's own
docs resolve. Wired into .github/workflows/ci.yml on push/PR to main.
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
1 participant
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.
Summary
Continues open-source prep (#59, #60, #63, #64). This repo has no automated test suite for behavior — validating what
/create-dev-loopactually generates still requires running it against a real repo (CLAUDE.md's "Testing changes" section), and that's not something CI can do without an LLM in the loop.But CLAUDE.md documents two hard invariants that were previously only checked by eye:
{{placeholder}}used in the generated-skill template needs a corresponding row in the Step 4 substitution tablecreate-dev-loop.md's Stepsscripts/check_docs.py(stdlib-only, no dependencies) enforces both mechanically by parsing the template out of its fenced code block and diffing it against the substitution table and the README list, plus checks that relative links between the repo's own.mdfiles resolve to real files (the kind of thing #60 fixed by hand). Wired up via.github/workflows/ci.ymlon push/PR tomain. Added a CI badge to the README.Test plan
python3 scripts/check_docs.pypasses on the current treedrafted by Claude on behalf of Daniel Stephenson