Post-merge docs sweep: restore cross-links, route to new pages, fill CHANGELOG#126
Merged
Merged
Conversation
The seven PRs that just merged (#117-#123) added new features (tour, persona, stability markers, --force, etc.) and four new wiki pages (Glossary, Stability, Upgrading, Errors-and-Recovery). Two cross-links between the new pages were dropped during the CI dance because they were forward-references at the time; this commit restores them now that everything's on main, plus extends the existing entry points to point at the new pages so users actually find them. - Restore `Glossary -> Upgrading` link under "scaffold version" entry. - Restore `Upgrading -> Stability` link in the breaking-change section. - Wiki index `Recommended Reading` table now lists Glossary, Upgrading, Stability, and Errors-and-Recovery with one-line "what you get" descriptions. - Getting Started's "Smallest Useful Path" now mentions `tour` as the optional orientation step and documents the persona flag. - FAQ gains four new entries: where to look up unfamiliar terms (Glossary + tour), how to scope output to your job (persona), what to do when a command fails (Errors and Recovery), and what stability marker promises (Stability). - README "Looking for a specific entry point?" note now links Glossary, Errors-and-Recovery, Stability, and Upgrading; the persona paragraph names the actual CLI invocation. - CHANGELOG `[Unreleased]` documents every feature, fix, doc page, and test bump from the seven merged PRs. Test count updated to the real number (590).
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.
Summary
Now that PRs #117–#123 are all merged on main, this sweeps the docs/wiki/README/CHANGELOG to make sure they actually describe everything that's new and have no stale or inconsistent links.
Cross-links restored (dropped during the original CI dance because they were forward-references between PR branches):
Routing into the new pages:
CHANGELOG: `[Unreleased]` now documents every Added / Fixed / Changed / Documentation / Tests item from the seven merged PRs (tour, --persona, stability markers, subcommand --help, doctor rationale, --force, template renderer fix, errors style, four new wiki pages, test coverage gap fill, acceptance audit). Test count corrected to the real number (590).
Test plan