docs: document help subcommand and ADR-0008 numbering gap - #465
Merged
Conversation
Add the clap-auto-generated `help` subcommand to the README Commands: synopsis so it matches real `wirerust --help` (v0.13.3) output, and add a one-line note to the CLAUDE.md Project References table explaining why docs/adr/ numbering skips 0008 (withdrawn, placeholder stub kept to reserve the ID). Resolves the 2 LOW STALE-DOC findings from maintenance run maint-2026-09-05 (Sweep 2). Docs-only change (README.md, CLAUDE.md) — outside the CHANGELOG- obligation trigger set (src/, Cargo.toml, bin/) per AC-158-001 / PG-W71-CHANGELOG, so no CHANGELOG entry is included. Claude-Session: https://claude.ai/code/session_01EQAaPvh9fwaG31jmkPicKW
Zious11
added a commit
that referenced
this pull request
Sep 6, 2026
…rged, #451 deferred, #407 request-changes posted Session resumed from PAUSED (D-555). Human directive: clear the carry-over PRs from maint-2026-09-05. - 3 held Dependabot GitHub-Actions bumps supply-chain reviewed MERGE-SAFE and merged to develop: #455 codeql-action (1c7d740), #449 scorecard-action (36bccab, also patches transitive CVE-2026-53488/ 47262/34986), #436 actions/checkout (9c49951). Held set now empty. - Docs-only PR #465 squash-merged (97361cd), resolving the 2 LOW STALE-DOC findings from maint-2026-09-05 Sweep 2. - PR #451 (dtolnay-pin) DEFERRED per explicit human decision — untouched. - PR #407 (fork-friendly-release-ops) given a full review; CHANGES_REQUESTED posted to the contributor; remains open under PR-407-FORK-RELEASE-OPS. - develop_head adc9428 -> 97361cd; backlog remains empty. - Two process observations recorded in cycles/maint-2026-09-05/lessons.md (L-3 PG-MERGE-WRAPPER-BYPASS, L-4 PG-MAINT-CLASSIFIER-MERGE-BLOCK recurrence). STATE.md is ~118KB / NEEDS-COMPACT. A /compact-state pass is advisable before the next burst; not performed in this burst. Single-commit burst (TD-VSDD-053). Claude-Session: https://claude.ai/code/session_01EQAaPvh9fwaG31jmkPicKW
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.
Fix: docs-only STALE-DOC cleanup (maint-2026-09-05, Sweep 2)
Finding: 2 LOW STALE-DOC findings from maintenance run
maint-2026-09-05(Sweep 2), nowauthorized for delivery (human directed clearing of carry-over items).
Source: maintenance-sweep
Severity: LOW
What Changed
## Usage→### OptionsCommands:synopsis block was missing thehelpsubcommand that clap auto-generates. Added thehelpline so the synopsis matchesreal
wirerust --help(v0.13.3) output verbatim.docs/adr/row enumerated ADRs 0001–0013 butsilently skipped 0008, which exists on disk as a withdrawn placeholder. Added a one-line note
explaining the numbering gap (
docs/adr/0008-withdrawn-placeholder.md— ADR-0008 withdrawn,replaced by a placeholder stub to keep the ID reserved).
Why
Both are documentation-drift findings: the README synopsis had fallen out of sync with actual
--helpoutput, and the CLAUDE.md ADR index had an unexplained numbering gap. Neither changesbehavior — this PR only brings docs in line with current, already-shipped reality.
CHANGELOG
No
[Unreleased]CHANGELOG entry is included. This PR touches onlyREADME.mdandCLAUDE.md— outside the CHANGELOG-obligation trigger set (
src/,Cargo.toml,bin/) per AC-158-001 /PG-W71-CHANGELOG.
Testing
src/,Cargo.toml, orbin/files touchedcargo fmt --checknot applicable (no Rust source changed)Commands:synopsis verified to matchcargo run -- --helpoutput verbatimhttps://claude.ai/code/session_01EQAaPvh9fwaG31jmkPicKW