Skip to content

Document Steps 1 and 4 in README, update CLAUDE.md conventions - #38

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/doc-accuracy
May 26, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/doc-accuracy

Conversation

@dmccoystephenson

@dmccoystephenson dmccoystephenson commented May 26, 2026 •

Copy link
Copy Markdown
Member

Summary

Doc-accuracy follow-up from today's audit. Two findings closed:

README.md — "What it does" lists 6 bullets but the template has 7 Steps

Violated the README-enumerate-every-Step convention that example-h-dev-loop exists to enforce. Step 1 (Identify) was folded into the separate Usage section; Step 4 (Fill in placeholders) was implicit inside the "Generate" bullet. Now both are explicit, and each bullet states its 1:1 mapping to the template Step.

CLAUDE.md — two missing conventions

What didn't change (and why)

  • Hard-coded "Claude Sonnet 4.6" co-author trailer in template line 351. Intentional — that's the runtime model dev-loops execute as, not a stale value. (The current audit ran on Opus 4.7 but Opus is the auditor, not the runtime.)
  • GITHUB_OWNER/REPO combined row in Step 4 table. Strict-reading nit only; the two tokens behave identically downstream. Defer to a separate PR if you want stricter token accounting.

Test plan

  • Confirm "What it does" now lists exactly 7 bullets matching Steps 1–7 of create-dev-loop.md.
  • Confirm CLAUDE.md "Skill file conventions" lists 5 bullets (was 3).
  • Confirm CLAUDE.md "Testing changes" lists 5 items (was 3).

Related: example-skills-catalog#6 (CONVENTIONS.md post-retrofit update — picks up the template-version convention there too).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

README "What it does" listed 6 bullets but the template has 7 Steps —
violating the README-enumerate-every-Step convention tracked by
cdl-dev-loop. Steps 1 (Identify) and 4 (Fill in placeholders) are now
explicit bullets. Each bullet now states its 1:1 mapping to the
corresponding template Step.

CLAUDE.md additions:
- Skill file conventions: added the README-enumerate rule (third
  structural rule from cdl-dev-loop's identity) and the template-version
  HTML header convention (#22).
- Testing changes: added items 4 and 5 for template-version header
  verification and end-to-end MODE=update exercise.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dmccoystephenson
dmccoystephenson merged commit d25c0a4 into main May 26, 2026
@dmccoystephenson
dmccoystephenson deleted the feature/doc-accuracy branch May 26, 2026 00:48
dmccoystephenson added a commit that referenced this pull request Aug 3, 2026
README "What it does" listed 6 bullets but the template has 7 Steps —
violating the README-enumerate-every-Step convention tracked by
cdl-dev-loop. Steps 1 (Identify) and 4 (Fill in placeholders) are now
explicit bullets. Each bullet now states its 1:1 mapping to the
corresponding template Step.

CLAUDE.md additions:
- Skill file conventions: added the README-enumerate rule (third
  structural rule from cdl-dev-loop's identity) and the template-version
  HTML header convention (#22).
- Testing changes: added items 4 and 5 for template-version header
  verification and end-to-end MODE=update exercise.

Co-authored-by: BuildTools <unconfigured@null.spigotmc.org>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant