Repository navigation
docs: fix Mermaid sequence diagrams broken by semicolons - #52
Merged
Merged
Conversation
Mermaid treats ';' as a statement separator in sequence diagrams, so message text containing a semicolon was truncated and the remainder failed to parse (e.g. the Three-Party Flow diagram in README.md). Replace prose semicolons with commas, and use Mermaid entity codes (#lt; #gt; #59;) where the characters are meaningful syntax in bootstrap-enrollment.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced Oct 1, 2026
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.
Problem
The Three-Party Flow diagram in
README.mdfails to render on GitHub:In Mermaid sequence diagrams,
;ends a statement just like a line break. Message text containing a semicolon gets cut off, and the parser then fails on what follows. Eight more diagrams in the docs had the same problem.Fix
docs/workflows/bootstrap-enrollment.md, the semicolons are part of real syntax (</>and thesig=jkt-jwt;jwt=header value), so they now use Mermaid escape codes (#lt;,#gt;,#59;) to keep the rendered text the same.Files:
README.md,docs/getting-started.md,docs/workflows/{bootstrap-enrollment,federated-access,ps-asserted-access,resource-managed-access,wallet-protocol}.md,samples/Concierge/README.md.Validation
Ran every Mermaid block in the repo's Markdown (excluding the vendored
aauth-spec/) throughmermaid.parse: 9 of 31 failed before this change, 0 of 31 fail after it. I haven't checked how they render on GitHub yet; the#lt;,#gt;and#59;codes inbootstrap-enrollment.mdshould display as<,>and;.