Repository navigation
docs: add an overview diagram to the README - #98
Merged
Merged
Conversation
The README gets a "How it works" diagram: the inputs, the design run that stops at the human design gate, and the code run that ends in a human PR merge and a knowledge update. Source in docs/diagrams/overview.mmd, rendered to light and dark SVGs with plain-text labels.
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.
Adds an overview diagram near the top of the README (new "How it works" section): the inputs
(requirement, target repositories, the knowledge base
aiws discoverbuilds), the design runthat stops at the human design gate, and the code run that ends in a human PR merge and a
knowledge update.
docs/diagrams/overview.mmd, configdocs/diagrams/mermaid.config.json(plain SVGtext labels, no
foreignObject); the re-render commands are in the comment at the top of the.mmd(the repository has no rootpackage.json).<picture>and absolute raw URLs onmain, so the imagesonly appear once this is merged.
docs/diagramssits outside the npm package (aiws/adapters/cli,files: bin, src, kit) andoutside
aiws/docs, which the kit bundles. README.vi.md and the landing page are unchanged.