Skip to content

DX-054: Add build-time Mermaid diagram support #566

Description

@IbrahimIjai

Context

Architecture and transaction-flow pages need diagrams, and diagrams drawn in
image editors go stale because nobody can edit them. Mermaid in a fenced block
is reviewable in a diff. Rendering it at build time keeps the client library out
of the bundle.

Scope

  • Render ```mermaid fences to inline SVG at build time; no client-side Mermaid.
  • Theme the output from design tokens and emit both theme variants, switched by
    CSS like code blocks (DX-035).
  • Every diagram carries an accessible name and description, authored via a
    required caption — a diagram with no text alternative fails the build.
  • Wide diagrams scroll inside their own container.
  • A malformed diagram fails the build with the file and the parser error.

Acceptance criteria

  • No Mermaid library in the client bundle; bundle delta stated.
  • Diagrams are legible in both themes with correct token colors.
  • A caption-less diagram fails the build.
  • A wide diagram scrolls internally at 360px with no page scroll.

Out of scope

  • Interactive or zoomable diagrams.

Spec: docs/dx_1/001_docs_site.md §4 · Depends on: DX-053

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardStellar WaveIssues in the Stellar wave programThird CampaignCampaign: Third CampaigndocumentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions