Skip to content

docs(architecture): fix volume-content diagram rendering - #3621

Open
HeyiSun wants to merge 1 commit into
e2b-dev:mainfrom
HeyiSun:codex/fix-volume-content-mermaid
Open

docs(architecture): fix volume-content diagram rendering#3621
HeyiSun wants to merge 1 commit into
e2b-dev:mainfrom
HeyiSun:codex/fix-volume-content-mermaid

Conversation

@HeyiSun

@HeyiSun HeyiSun commented Sep 6, 2026

Copy link
Copy Markdown
Contributor

The volume-content sequence diagram in docs/ARCHITECTURE.md fails to render on GitHub because the semicolon after BYOC teams is parsed as a statement separator. Escape it as #59; so the note displays as written.

Rendering before and after

Before (current main)

GitHub displays Unable to render rich display:

Parse error on line 12:
... for BYOC teams;<br/>SDK stores it and f
-----------------------^

After (updated file)

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 content
Loading

Checked all six diagrams with Mermaid 11.17.2 and in GitHub's preview. git diff --check passes.

AI-assisted: yes.

@cla-bot

cla-bot Bot commented Sep 6, 2026

Copy link
Copy Markdown

We require contributors to sign our Contributor License Agreement, and we don't have @HeyiSun on file. You can sign our CLA at https://e2b.dev/docs/cla . Once you've signed, post a comment here that says '@cla-bot check'

@HeyiSun

HeyiSun commented Sep 6, 2026

Copy link
Copy Markdown
Contributor Author

@cla-bot check

@cla-bot cla-bot Bot added the cla-signed label Sep 6, 2026
@cla-bot

cla-bot Bot commented Sep 6, 2026

Copy link
Copy Markdown

The cla-bot has been summoned, and re-checked this pull request!

@HeyiSun HeyiSun changed the title docs: fix volume-content diagram rendering docs(architecture): fix volume-content diagram rendering Sep 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant