docs: rewrite the tour and README as verified, terse reference - #35
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
docs/tour/01–09as terse reference: the four required headings, tables and bullets, relevant diagrams embedded. Narrative moved out; one lesson became a bullet indocs/runbook/ci-is-red.md.unitjob runsmise run ci-unit; the branch ruleset sets no required status checks; the06delete test does fail (check-paths.mjsruns inlintandcheck); "Try it" commands usednode, which the toolbox does not have.README.mddown to pitch, install, synopsis, tiers, services and links. Command detail and environment variables live indocs/README.md#commands; the reading path lives only indocs/README.md. The synopsis addspublish --privateandlist [--adapters] [--services].scaffoldruns through a symlink: it does not (test fixtures rely on that by design, see 4d02b05). It shows aPATHinstall instead.CONTRIBUTING.mdandSECURITY.mdtightened.How it was verified
file:line, verdict); an independent review re-checked the claims and looked for facts lost without a home. Two lost facts were restored (RedisCacheModulewiring, the DynamoDB exclusion).bats tests/documentation.bats5/5,mise run test-unit204/204,mise run lintclean.Checklist
mise run lintpassesmise run test-runnerpasses — docs only; CI runs it