Repository navigation
docs: add an architecture page for contributors, move the syntax reference under Using the CLI, vendor docs kit 1.26.0 - #107
Merged
Conversation
…eference under Using the CLI
…, drop the domain internals
…on, diagrams top down, plain step numbers
emaarco
force-pushed
the
emaarco/docs-contributing-architecture-page
branch
from
October 27, 2026 11:28
416ada6 to
7aaa1e6
Compare
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.
Summary
Contributors could not see how a command gets from the terminal into the domain model, or how the hexagonal layout of
src/is meant to work. This PR adds a page that shows it and tidies the docs navigation.docs/architecture.mdin a new sidebar group "Contributing". It starts with the hexagon and the import rules thattest/architecture.test.tschecks. Its core is the journey ofbpmn add: a compact diagram of eight numbered stops, one class each, with one colour per layer. A short section per stop follows, with the file and the real code that hands over to the next stop, and at the end howbpmn apply,mutateFile()andapplyToXml()differ. Finally, the command definitions and what a new command needs. "Where new code goes" links to CONTRIBUTING.md instead of repeating it. Three reader personas (new contributor, maintainer, library user) reviewed an earlier draft, and their findings are worked in./referencestays, so links from the README keep working. Link texts incommands.md,contract.mdand the README follow the new title.<div data-zoom>opens anything else the same way. The CI checkout of corporate-identity moves fromv1.10.0tov1.26.0, as the comment next to it asks.Checklist
npm run typecheckpassesnpm run gatepassessrc/report/guide.tsand the matching page indocs/are updated (only if a command, option or output changed)Also checked:
npm run docs:buildpasses,check:kitreports "Kit 1.26.0: 14 Dateien unverändert.", and all diagrams render without Mermaid errors. The overlay was checked in a browser in light and dark mode.Linked issue
None.