docs: add a from-zero overview with architecture diagrams - #34
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/README.md, the from-zero entry page: what scaffold is, repository map, howscaffold newworks, what a generated project contains, commands table, glossary, reading path.docs/diagrams/(HTML source + exported SVG): system context, code layers,scaffold new, generated project, release flow,scaffold update. Each node was derived from the code, not from existing prose.README.md: links the new page first under Documentation.How it was verified
docs/README.mdand the diagrams checked againstscaffold,lib/*.sh,common/and the reusable workflows; an independent review re-checked them.bats tests/documentation.bats5/5 (a deliberately broken path and image in the new page made the path and link tests fail).mise run test-unit199/199.mise run lintclean.Checklist
mise run lintpassesmise run test-runnerpasses — docs only; CI runs it