docs: link every page from the entry points and align CLI text - #37
Merged
Merged
Conversation
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.
What this changes
Closes the whole-branch review of the documentation overhaul (#33–#36).
docs/README.mdreading path now links every tour page, every runbook (including the first-project walkthrough), the key ADRs,docs/decisions/anddocs/PROVENANCE.md, so a from-zero reader reaches every page fromREADME.md.publish-a-project.mdcredits the--no-protectskip toapply_repo_settings;ci-is-red.mddrops an unverifiable history claim; ADR mentions inREADME.mdandCONTRIBUTING.mdare links.scaffold usage()lists what the dispatch already accepts:publish --private,-h, --help,-v, --version. Text only.scaffoldand the comment inlib/publish.shcited ADR-0004, which is about keeping the toolbox out of projects; they now cite ADR-0024, which decides the ruleset.tests/publish.batsasserts the corrected message.lib/update.sh's comment names the template's realroots: '["docs"]'.How it was verified
bats tests/documentation.bats tests/cli.bats tests/publish.bats tests/update.bats51/51.mise run test-unit199/199.mise run lintclean.Checklist
mise run lintpassesmise run test-runnerpasses — text-only changes; CI runs it