docs: fix mermaid parse errors in components and design diagrams#9
Merged
Conversation
Four diagrams failed to render on GitHub: - skeleton flowchart (components.md): backtick fenced-code inside a node label broke the lexer; the decision node with <br/>/≥ was unquoted. - DSL 8-stage flowchart (components.md): nested [] inside [...] node labels (replace[], match_output[]) broke lexing. - apply.Body and expand-loop sequence diagrams (design.md): a ';' in message/Note text is a statement separator in sequenceDiagram, which truncated the text and errored on the following <br/>. Quote the affected labels and replace the two ';' with ',' / '—'. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Osher-Elhadad <Osher.Elhadad@ibm.com>
github-project-automation
Bot
moved this from New/ToDo
to Done
in Rossoctl Issue Prioritization
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
2 participants
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
Four mermaid diagrams in the docs failed to render on GitHub. Fixes are label-quoting and punctuation only — no wording/content changes.
docs/components.mdskeletonflowchart```gobackticks inside a node label broke the lexer; decision node with<br/>/≥was unquoteddocs/components.md[]inside[...]labels (replace[],match_output[])docs/design.mdapply.Bodysequence;is a statement separator insequenceDiagram, truncating the message and erroring on the following<br/>;→,docs/design.md;issue in aNote;→—These match the exact GitHub render errors reported (
Lexical error ... flowchart LR A["```go fenced block<brandParse error on line 10 ...keep bytes;<br/>changed).Verification
No mermaid CLI available in-env; verified by grep that no remaining diagram contains the three parse-breaking constructs (backticks-in-label, nested
[],;in sequence text). The other mermaid blocks inintegrations.md/setup.mdwere checked and are clean.