Repository navigation
docs(diagrams): fix the mermaid diagrams that did not render well - #62
Merged
Merged
Conversation
Rendering every Mermaid block with Mermaid 11 in headless Chrome showed three problems the Markdown never revealed: - The rollback sequence did not render at all. Its note contained a semicolon, which Mermaid reads as a statement separator, so GitHub has shown a syntax error in its place since it merged. - The lifecycle sequence's sweep note was one line wider than its box; Mermaid does not wrap notes, so it now breaks the line itself. - The platform flowchart laid out as a wide tangle of long crossing edges that scaled to unreadable text; it is now a summary with five edges, and the draw.io platform overview carries the detail. The draw.io sequence renderer now reads a Mermaid line break as a space and wraps on its own, so the two stay in step. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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 changes
Three of the nine Mermaid diagrams are corrected, and the draw.io sequence pages that are rendered from them stay in step:
docs/Sequence diagrams.md) renders again. Its note said "…forbidden; it would be reverted…", and a semicolon ends a statement in Mermaid, so the block failed to parse.docs/Architecture diagrams.md) becomes a readable summary: five edges instead of twelve, left to right, with the draw.io platform overview linked from the same page for the detail.Why
The maintainer asked for every diagram made in this work to be checked by rendering it, after the draw.io pages showed defects a geometry check had missed. The Mermaid blocks had only ever been read as text. Rendered, one of them turned out to be broken on GitHub since microservice-app-docs#54, where it shows "Syntax error in text" instead of a diagram.
Tasks
No task register covers documentation in this repository. This corrects work closed under microservice-app-docs#52, which is noted there.
Neither box applies literally: nothing is ticked here.
How it is verified
All nine Mermaid blocks were rendered with Mermaid 11 (11.17.2, from jsDelivr) in headless Chrome and each image inspected: the three architecture diagrams and the six sequences.
;and#, the two characters that break Mermaid statements, finds none.The two draw.io sequence pages whose source text changed, Rollback and Profile lifecycle, were re-exported with the draw.io CLI and inspected. Every page still matches its Mermaid message count: 13, 11, 12, 5, 16 and 7.
Markdown and a draw.io file only.
Risk and rollback
None to the running system. Revert the commit.
What this PR does not do
It does not change the Eraser workspaces, which are outside Git. Their state is reported to the maintainer separately.
🤖 Generated with Claude Code