docs: rewrite runbooks as verified steps and correct stale ADR facts - #36
Merged
Merged
Conversation
5 tasks
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
When/ numberedStepswith exact commands /Verify/If it fails.first-project-walkthrough.md351 → 162 lines; it installsscaffoldonPATH(a symlink is unsupported)..envalone locks the apps out (the images read it only on an empty volume), so the runbook now changes it inside the database first;ci-is-reddescribed CI as one contract task per step (it runsci-unitper config root); the provenance check compares files to the pinned commit rather than detecting upstream movement.update-a-project.md(embeds the update diagram) andpublish-a-project.md; both linked fromdocs/README.md.> **Amended 2026-09-17.**note. ADR-0010 and ADR-0014 gain a "Superseded in part" status pointing at the ADRs that changed them.docs/PROVENANCE.md: prose and three Notes cells corrected; parsed columns untouched.How it was verified
scaffold,lib/*.sh,common/and the reusable workflows; commands needing GitHub or Docker checked by--helpand code, not run. An independent review re-checked them and found one dropped operator warning (edits to a deployedcompose.yamlare overwritten byinstall.sh), now restored.scripts/check-provenance.sh: 1 ok, 0 drifted.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