docs: embed mermaid diagrams inline (drop docs/diagrams)#28
Merged
Conversation
GitHub does not embed linked .mmd files inline in another markdown, so the previous setup forced readers to click through to see each diagram. Move each diagram to a fenced mermaid block where it is consumed: - C1 system context inline in docs/overview.md - C2 container architecture inline in the root README under Architecture - Trade execution sequence inline in docs/flows/trade-execution.md Remove docs/diagrams/ as a separate folder and drop the broken docs/packages/protocol-core.md link in docs/overview.md left over from the previous follow-up.
Add accTitle and accDescr directives to every inline mermaid block so screen readers announce a meaningful diagram title and description instead of the raw graph IDs. Add ADR 003 capturing the decision to use inline mermaid blocks over .mmd source plus CI-rendered SVG, including the wins, costs, and revisit triggers.
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
1 participant
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
Follow-up to #26 / #27. Move all mermaid diagrams from
docs/diagrams/*.mmdfiles into inline fenced blocks where they are consumed.Why
GitHub renders standalone
.mmdfiles when you click them, but it does not embed them inline when linked from another markdown. The previous setup forced readers to click through every link to see each diagram. Inline mermaid blocks render directly in the README and docs.Changes
README.md— new## Architecturesection with the C2 container diagram inline (renders on the repo home page).docs/overview.md— C1 system-context diagram embedded right after the "What" section.docs/flows/trade-execution.md— flow sequence diagram embedded under a## Sequencesection.docs/flows/chain-onboarding.md— diagram reference updated to point atREADME#architecture(no dedicated diagram for this flow).docs/diagrams/c1-context.mmd,docs/diagrams/c2-containers.mmd,docs/diagrams/flow-trade.mmd. Folder deleted.docs/overview.mdthat pointed at./packages/protocol-core.md(deleted in docs: move package docs to per-package READMEs #27).The Diátaxis line caps still apply to prose; mermaid blocks are visual content and do not count against them.
Test plan
docs/overview.md— C1 context diagram renders inlinedocs/flows/trade-execution.md— sequence diagram renders inline.mmdfiles remain (grep -r "\.mmd" .is clean)