docs: fix volume-content mermaid diagram rendering - #3626
Open
forrestIsRunning wants to merge 1 commit into
Open
docs: fix volume-content mermaid diagram rendering#3626forrestIsRunning wants to merge 1 commit into
forrestIsRunning wants to merge 1 commit into
Conversation
GitHub fails to render the Volume content sequence diagram because Mermaid treats ';' as a statement separator and HTML </> entities as invalid tokens. Use Mermaid entity codes so the note and domain placeholders parse.
forrestIsRunning
requested review from
ValentaTomas,
dobrac and
jakubno
as code owners
September 7, 2026 23:02
Contributor
|
duplicate with #3621 |
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.
Problem
The Volume content sequence diagram in
docs/ARCHITECTURE.mddoes not render on GitHub:Mermaid sequence diagrams treat
;as a statement separator (equivalent to a newline). AfterBYOC teams;, the parser starts a new statement at<br/>and fails. The same diagram also uses HTML</>for domain placeholders; those are invalid tokens in current Mermaid.This is a docs-only bug. CONTRIBUTING.md says documentation fixes can skip the issue-first step.
Fix
Use Mermaid entity codes in that sequence diagram, which is the documented way to keep the original text:
;#59;<#lt;>#gt;The rendered note and
api.<domain>placeholders stay the same. Surrounding prose is unchanged.Diagram after the change (should render below)
sequenceDiagram autonumber participant U as SDK participant API as API participant PG as PostgreSQL participant VC as volume-content API (belt) U->>API: POST /volumes (create) or GET /volumes/{id} API->>PG: persist / load volume row API->>API: mint JWT (aud = https://api.#lt;domain#gt;)<br/>resolve domain API-->>U: { volumeID, name, token, domain? } Note over U: domain is returned only for BYOC teams#59;<br/>SDK stores it and falls back to api.#lt;E2B_DOMAIN#gt; otherwise U->>VC: /volumecontent/{id}/... at api.#lt;domain#gt;<br/>Authorization: Bearer token VC->>VC: verify token (audience must match its own origin) VC-->>U: file contentValidation
maindocs/ARCHITECTURE.mdwith Mermaid 11.12.0 after the changemake test/make lintdo not applyRelated: #3621 also addresses the GitHub parse error by escaping the semicolon. This change also replaces the HTML entities so the diagram parses in current Mermaid, not only GitHub's renderer.