docs(contributing): name all four doc files a new command must update - #743
Merged
Conversation
Step 5 said "update CHANGELOG.md" and "add to README.md if major feature". docs/index.html and docs/DEPENDENCY-MATRIX.md appeared only in CLAUDE.md, which contributors do not read, so PRs kept arriving without them — #739 and #740 both did. Reviewing against a requirement we never wrote down is our omission, so the guide now carries the same list as CLAUDE.md step 7. Adds a step 6 for the count claims, which go stale in five places on a new overlay command and are checked by nothing. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VKbHCujejpxkgvh47BndDE
umag
added a commit
to umag/arc-kit
that referenced
this pull request
Aug 7, 2026
…two doc files The regime guard added by tractorjuice#744 fails on this branch: EUCSF is an EU-regime doc-type but the Regime index table in RENDERING.md still lists only the seven pre-existing EU codes. [FAIL] RENDERING.md "Regime index" omits EU doc-type(s): EUCSF Adds EUCSF to that row, then re-runs sync-shared-assets.py (14 community plugins), sync-claude-plugin-layout.py and converter.py. EU still falls through to step 2 — no REGIME_PARTIALS entry, because EU has no ladder of its own. Also copies the partial into .arckit/templates/_partials/, which sync-shared-assets does not cover and test_plugin_and_cli_partials_are_in_sync checks. A tenth registration point, not in CONTRIBUTING.md: guide-groups.mjs carries an explicit per-guide list, so eu-cloud-sovereignty.md landed in "Other / Uncategorised" and test_codex_hook_runs_pages_preprocessor failed on other_guides == []. Added to the "Community overlays - EU" group. IMPORTANT 3 and 4 from the review, which you offered to absorb — taking them here instead, since tractorjuice#743 has landed and CONTRIBUTING.md step 5 now names all four documentation files: - docs/DEPENDENCY-MATRIX.md: the command entry, an inter-dependency line (feeds fr-secnumcloud optionally, consumes eu-nis2 assurance rather than duplicating it), and its place in the EU flow block - docs/index.html: all three EU regulation enumerations — the feature list, the community-overlay paragraph, and the EU jurisdiction card Full Python suite: 1269 passed, 225 skipped. All seven check scripts pass, both sync --check runs clean, test-regime-registration.mjs passes, markdownlint-cli2 clean repo-wide. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
umag
added a commit
to umag/arc-kit
that referenced
this pull request
Aug 7, 2026
…two doc files The regime guard added by tractorjuice#744 fails on this branch: EUCSF is an EU-regime doc-type but the Regime index table in RENDERING.md still lists only the seven pre-existing EU codes. [FAIL] RENDERING.md "Regime index" omits EU doc-type(s): EUCSF Adds EUCSF to that row, then re-runs sync-shared-assets.py (14 community plugins), sync-claude-plugin-layout.py and converter.py. EU still falls through to step 2 — no REGIME_PARTIALS entry, because EU has no ladder of its own. Also copies the partial into .arckit/templates/_partials/, which sync-shared-assets does not cover and test_plugin_and_cli_partials_are_in_sync checks. A tenth registration point, not in CONTRIBUTING.md: guide-groups.mjs carries an explicit per-guide list, so eu-cloud-sovereignty.md landed in "Other / Uncategorised" and test_codex_hook_runs_pages_preprocessor failed on other_guides == []. Added to the "Community overlays - EU" group. IMPORTANT 3 and 4 from the review, which you offered to absorb — taking them here instead, since tractorjuice#743 has landed and CONTRIBUTING.md step 5 now names all four documentation files: - docs/DEPENDENCY-MATRIX.md: the command entry, an inter-dependency line (feeds fr-secnumcloud optionally, consumes eu-nis2 assurance rather than duplicating it), and its place in the EU flow block - docs/index.html: all three EU regulation enumerations — the feature list, the community-overlay paragraph, and the EU jurisdiction card Full Python suite: 1269 passed, 225 skipped. All seven check scripts pass, both sync --check runs clean, test-regime-registration.mjs passes, markdownlint-cli2 clean repo-wide. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
CONTRIBUTING.mdstep 5 told contributors to updateCHANGELOG.mdand to add toREADME.md"if major feature".docs/index.htmlanddocs/DEPENDENCY-MATRIX.mdappeared only inCLAUDE.mdstep 7 — a maintainer-facing file contributors do not read.The result is that PRs arrive without them and then get reviewed against a requirement that was never written down. #739 and #740 both did exactly this. That is our omission, and the PR says so in as many words.
Changes
Step 5 now names all four files with what each one actually needs, rather than a bare list:
CHANGELOG.md## [Unreleased]README.mddocs/index.htmldocs/DEPENDENCY-MATRIX.mdThe
README.mdline drops "if major feature". For an overlay command it is not discretionary: those section headers carry counts (The 21 commands below …) that go stale the moment one is added.New step 6 covers the count claims, which are the part people miss even when they remember the four files. A new overlay command changes a stated number in five places:
README.md(N slash commands).claude-plugin/plugin.jsondescriptionREADME.mdsection headerNothing checks any of them.
Verification
Docs-only; no commands, config, or scripts touched.
Follows #741, which covered the overlay registration points. Same root cause: integration requirements recorded somewhere contributors never see.
🤖 Generated with Claude Code
https://claude.ai/code/session_01VKbHCujejpxkgvh47BndDE