Align the README With the Declared Structure - #92
Merged
Conversation
Ten findings, all in the README, and none of them visible to a reader who is not comparing it against the fleet model. The Overview section carried its retired name, Use Cases. Renaming it orphaned the Table of Contents anchor, which markdownlint caught as MD051 rather than shipping a link into nothing, and that is the whole reason a rename is not a one-line change. The link definitions used a Workflow group the model does not declare, and the Repo group held six references to this repository's own GitHub pages, which the model classifies as distribution rather than local. The block is rebuilt into the four declared groups it needs, Shields, Distribution, Repo and External, each sorted by reference name. Every one of the 29 definitions is preserved, and the classification comes from the audit's own link_kind rule against the model's declared URL prefixes rather than from reading the URLs by eye. The 3rd Party Tools table dropped its License column, since a license belongs to the dependency and is authoritative at its source, so restating it is a maintenance obligation carrying no information. Its three rows now use the fleet's own descriptions, because a shared tool carries one description across the fleet rather than a per-repo paraphrase, and the rows are alphabetized, since the list is scanned rather than read. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR completes the resync’s README alignment work by updating section structure and link-definition grouping so the document matches the declared fleet/model structure and passes markdown linting checks.
Changes:
- Renames the retired
Use Casessection toOverviewand updates the Table of Contents anchor accordingly. - Simplifies and normalizes the “3rd Party Tools” table by removing the License column and standardizing tool role descriptions.
- Reorganizes link reference definitions into the declared groups (notably replacing the old “Workflow” group with “Distribution”) and reorders definitions for consistency.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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 freeto 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.
Step 4, the last of the resync. Follows #89, #90 and #91.
Ten findings, all in the README, none of them visible to a reader who is not comparing it against the fleet model.
The retired section name, and what it broke
Use Casesis a retired name forOverview, which has no accepted aliases. Renaming it orphaned the Table of Contents anchor, caught bymarkdownlintasMD051rather than shipping a link into nothing.That is the whole reason a heading rename is not a one-line change, and it is the same class the hub's deletion sweep exists for: an inbound reference that breaks when its target moves. I swept for other inbound anchors to the old name and there were none.
The link definitions
Two structural problems:
Workflowgroup the model does not declare.Repogroup held six references to this repository's own GitHub pages, which the model classifies asdistributionrather thanlocal.Rebuilt into the four declared groups it needs, each sorted by reference name:
All 29 definitions preserved, verified by count. The classification is not my reading of the URLs: it comes from the audit's own
link_kindagainst the model's declareddistribution.urlPrefixes, so it matches what the checker will decide rather than what looks right.3rd Party Tools
Static site generator.,Hugo theme.,Web server.Verification
markdownlint-cli2clean (it failed first on the orphaned anchor, which is the gate doing its job),prose_lint --diff HEADclean,cspellclean on the gated files,editorconfig-checkerclean.After this
developcarries the whole resync. The two remaining audit findings on this repo arehub-onlyentries forpublish-release.ymlandvalidate-task.yml, both dispositionedinvestigatein the hub's ledger, which explicitly makes them not this repository's to settle.The resync then wants promoting to
main, since the audit readsmainas ground truth and would otherwise still report the pre-resync state.🤖 Generated with Claude Code