Document install step; add ISSUE_TEMPLATE to doc sources table - #102
Merged
Conversation
README never explained how to register create-dev-loop.md itself as a slash command, leaving first-time visitors with no way to actually invoke /create-dev-loop. CLAUDE.md's doc sources-of-truth table also omitted .github/ISSUE_TEMPLATE/*.md, which restates the same conventions as PULL_REQUEST_TEMPLATE.md and can drift the same way. Closes #96, closes #81
…README - tests/test_check_docs.py: fixture-based unit tests for check_docs.py's three checks, wired into CI, so a silently-broken check doesn't read as "0 errors -> pass". Closes #97. - create-dev-loop.md: add a "Steps at a glance" anchor-link TOC — Step 3 and Step 4 sit ~450 lines apart with a lot of example content between. Closes #99. - .github/workflows/ci.yml: pin actions/checkout and actions/setup-python to commit SHAs instead of major-version tags. Closes #100. - scripts/README.md: one-line pointer to CLAUDE.md/CONTRIBUTING.md. Closes #101 (no CHANGELOG added — fine to skip pre-1.0, per the same issue).
dmccoystephenson
added a commit
that referenced
this pull request
Aug 3, 2026
* Document install step and add ISSUE_TEMPLATE to doc sources table README never explained how to register create-dev-loop.md itself as a slash command, leaving first-time visitors with no way to actually invoke /create-dev-loop. CLAUDE.md's doc sources-of-truth table also omitted .github/ISSUE_TEMPLATE/*.md, which restates the same conventions as PULL_REQUEST_TEMPLATE.md and can drift the same way. Closes #96, closes #81 * Fold in nice-to-have readiness items: tests, TOC, pinned CI, scripts README - tests/test_check_docs.py: fixture-based unit tests for check_docs.py's three checks, wired into CI, so a silently-broken check doesn't read as "0 errors -> pass". Closes #97. - create-dev-loop.md: add a "Steps at a glance" anchor-link TOC — Step 3 and Step 4 sit ~450 lines apart with a lot of example content between. Closes #99. - .github/workflows/ci.yml: pin actions/checkout and actions/setup-python to commit SHAs instead of major-version tags. Closes #100. - scripts/README.md: one-line pointer to CLAUDE.md/CONTRIBUTING.md. Closes #101 (no CHANGELOG added — fine to skip pre-1.0, per the same issue).
8 tasks
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.
Summary
Must-fix (from the public-readiness review):
create-dev-loop.mditself as a slash command (symlink into~/.claude/commands/) — previously the README described what/create-dev-loopdoes but never said how a first-time visitor gets it registered. Closes README never documents how to install create-dev-loop.md itself as a slash command #96..github/ISSUE_TEMPLATE/*.mdrow to CLAUDE.md's "Documentation sources of truth" table — the three issue templates restate the same conventionsPULL_REQUEST_TEMPLATE.mdalready has a row for, and can drift the same way. Closes CLAUDE.md's documentation sources-of-truth table omits .github/ISSUE_TEMPLATE/*.md #81.Nice-to-have, folded in:
tests/test_check_docs.py— fixture-based unit tests forcheck_docs.py's three checks (placeholder sync, README/Steps sync, local-link resolution), wired into CI, so a silently-broken check doesn't read as "0 errors → pass". Closes scripts/check_docs.py has no test coverage of its own #97.create-dev-loop.md— adds a "Steps at a glance" anchor-link TOC; Step 3 and Step 4 sit ~450 lines apart with a lot of example content between. Closes create-dev-loop.md has no way to jump to a specific Step #99..github/workflows/ci.yml— pinsactions/checkoutandactions/setup-pythonto commit SHAs instead of major-version tags. Closes CI actions pinned to major version tags, not commit SHAs #100.scripts/README.md— one-line pointer toCLAUDE.md/CONTRIBUTING.md. Closes scripts/ has no README; repo has no CHANGELOG #101 (no CHANGELOG added — the issue itself says that's fine to skip pre-1.0).Not included: #98 (delete 13 stale, already-squash-merged branches) — confirmed all 11 currently-stale branches (2 named in the original issue are already gone) are
MERGEDviagh pr list, but the branch-deletion push was blocked by this environment's auto-mode classifier as a destructive/shared-repo action. Left for the maintainer to run directly:Doc sync check
README.md's "What it does" Step list still matchescreate-dev-loop.md's Steps 1:1 (unchanged — Installation and the new TOC are outside the Step list){{placeholder}}added or changed has a corresponding Step 4 substitution-table row — n/a, no placeholders touchedRESEARCH.mdupdated — n/a, no template/phase behavior changeTest plan
python3 scripts/check_docs.pypasses.python3 -m unittest discover -s tests -v— 13/13 new tests pass.~/.claude/commands/create-dev-loop.md -> .../create-dev-loop.md) and how Step 5 registers generated skills.actions/checkout@11d5960a...= v4.4.0,actions/setup-python@a26af69b...= v5.6.0) resolve to the tagged commits viagh api.MERGEDviagh pr list --state all --head <branch>.🤖 Generated with Claude Code