Repository navigation
docs: add a system map section to the landing page - #14
Merged
Merged
Conversation
Shows how capabilities, specs and decision records link into one graph, and how opt-in traceability adds code, tests and gaps to it. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QoEZp4TGpWNBkNtFXW2G3b
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QoEZp4TGpWNBkNtFXW2G3b
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.
Requested by Mathias · project thread
Before: the landing page said nothing about how capabilities, specs and decision records connect, or what traceability adds.
After: a new "A map of your software" section sits under How it works. It explains capabilities, specs, decisions and opt-in traceability. Next to the text is an example graph where a decision applies to a capability, the capability contains a requirement and its scenarios, and a function serves a scenario and follows the decision. A test covers the function and proves the scenario. An untested scenario and an unowned file are marked as gaps. Phones get a two-column version of the graph.
How: one new component,
docs/src/components/SystemMap.astro, added toindex.astro. Every node and edge kind in the diagram is one thatosq graphprints today (web-inspection "System graph" requirements), and the commands it names (osq graph,osq spec,osq report) all ship in 0.3.0. The edges carry a slow pulse that stops under reduced motion.