Skip to content

docs-freshness: inventory sync — every public surface named, every count true - #175

Merged
omercelikdev merged 1 commit into
mainfrom
docs-guard
Aug 24, 2026
Merged

docs-freshness: inventory sync — every public surface named, every count true#175
omercelikdev merged 1 commit into
mainfrom
docs-guard

Conversation

@omercelikdev

Copy link
Copy Markdown
Owner

Closes #174. The existing gate (links + retired names) gains the portal-proven inventory half: packages ⇄ capability ledger, numeric claims ⇄ reality, CLI verbs ⇄ reference, nightly GM shapes ⇄ golden-manifests doc, scripts ⇄ any reader-visible reference, templates ⇄ templates/README.

First run caught 12 real staleness bugs, all fixed in this PR — including packages/README claiming 19 of 23 packages and TEN undocumented nightly shapes (now a gate-kept table).

🤖 Generated with Claude Code

…unt true (#174)

The gate grows the portal-proven second half (qorpe/api-portal scripts/docs-guard.sh):
beyond broken links and retired names, it now fails when the docs stop NAMING reality:

- every package on the capability ledger (short/capability spelling accepted; providers
  ride their base row),
- any 'N packages' claim must equal the real count,
- every CLI verb the dispatcher knows is in the CLI reference,
- every nightly golden-manifest shape is in the golden-manifests doc,
- every script is referenced somewhere a reader looks,
- every template is in templates/README.

Its first run caught TWELVE real staleness bugs, all fixed here: packages/README claimed
19 of 23 · 'export compose' and 'help' missing from the CLI reference · TEN nightly
shapes undocumented (now a table the gate keeps honest) · bench-notification.sh and
roll-shipped.sh referenced nowhere · goldpath-worker absent from templates/README ·
Approvals + FileExchange missing from the coverage matrix (added as Ring C rows with
honest 🟡/🔷 states, foundational packages named as a section).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@omercelikdev
omercelikdev merged commit 9bfcc73 into main Aug 24, 2026
4 checks passed
@omercelikdev
omercelikdev deleted the docs-guard branch August 24, 2026 18:04
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.

docs-guard: documentation carries the tests' freshness contract (portal-proven pattern)

1 participant