Align the README Structure and Links With the Fleet Spec - #923
Merged
Conversation
Rename Use Cases to Overview and move Questions or Issues after Usage, so the declared sections keep their relative order. Rename the shared destinations to their fleet names (commits-link, docker-hub-link, a bare license path), split the Internal link group into Distribution and Repo, and give every 3rd Party Tools entry the fleet's one description and link.
There was a problem hiding this comment.
Pull request overview
Aligns README.md structure and reference-link naming with the fleet readme-structure spec to eliminate readme: audit findings, without changing application behavior.
Changes:
- Restructures headings/ToC (renames
Use Cases->Overviewand movesQuestions or Issuesafter usage-related content). - Normalizes reference-link names and groups (e.g.,
commits-link,docker-hub-link,licenseas a repo path; splits link groups into Distribution vs Repo). - Reworks “3rd Party Tools” into the fleet table format and updates a couple of external destinations (NBGV and Xml2CSharp).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Merged
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
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.
Close the
readme:letters the fleet audit reports againstdevelop(audit run2026-08-15T14:13:58Z | hub 0e84805 | branch override develop), per the hubspec/readme-structure.mdandspec/third-party-tools.json. On this branch the audit reports noreadme:finding (2026-08-15T14:39:03Z | hub 0e84805 | branch override readme-structure-2026-08-15).Use CasestoOverview(the heading has no accepted aliases) and moveQuestions or Issuesafter the Usage material, so the declared sections keep their relative order. The Table of Contents mirrors both.commit-linkbecomescommits-link,docker-linkandplexcleaner-hub-link(one Docker Hub image, two names) collapse intodocker-hub-link, andlicense-linkbecomes the barelicensesince it is a path in this repo.Internallink group splits intoDistribution(this project on GitHub and Docker Hub) andRepo(paths in this repository).3rd Party Toolsbecomes the fleet table shape, each entry carrying the fleet description, and two definitions are re-pointed at the fleet link (Nerdbank.GitVersioning to its repository, Xml2CSharp to https).Content-only, so no version bump. Companion to #922, which carries the instruction set and config resync.