Aureliusstatic documentation
Repository

guide · observed

Declarative diagrams

Ten declarative Mermaid examples rendered with the Diagram Design editorial system and an always-visible contextual legend.

One declarative contract

These examples have no authored SVG or HTML. Each JSON envelope points to a small Mermaid file; aurelius check validates its syntax and safety, while aurelius build compiles its semantic roles, discards source paint, applies Diagram Design's Minimal light system, and packages the renderer for offline use. The original source and its declarativeAnalysis remain available to agents. Every rendered Mermaid has a legend derived from the actual notation and a bounded viewport: drag to pan, use Ctrl/⌘ + scroll or the buttons to zoom, and open fullscreen or the dedicated full view when the model is large.

JSON
{
  "id": "order-decision-flow",
  "kind": "flowchart",
  "source": {
    "language": "mermaid",
    "path": "diagrams/sources/order-decision-flow.mmd"
  }
}

Create the same structure with aurelius visual init my-flow --site docs --kind flowchart. Mermaid is the default when Aurelius has an equivalent starter for the selected kind; --format mermaid is available when an explicit command is preferable. For a kind without such a starter, choose --format html or --format svg explicitly so the generated source never pretends that one visual grammar is another.

Decision flow

The decision shape carries branching semantics, every outgoing route is labeled, and one focal class marks the successful outcome.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Step
  • Decision
  • Outcome
  • Connection
  • Focal
Semantic reading

Orders without stock stop immediately. Available orders request payment; approved payments confirm the order, while declined payments loop through another payment method.

Declarative source: diagrams/sources/order-decision-flow.mmd

Sequence with an alternative

Time runs downward across four actors. The alt fragment keeps approval and rejection outcomes in one bounded branch.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Actor
  • Request
  • Response
  • Alternative
  • Focal
Semantic reading

Aurelius validates both content and diagram contracts before publication. Valid sources produce human and agent views; invalid sources return to the author with a targeted error.

Declarative source: diagrams/sources/publication-sequence.mmd

UML class model

Compartments keep attributes and operations distinct, while inheritance and composition remain explicit in the source.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Class
  • Interface
  • Inheritance
  • Composition
  • Focal
Semantic reading

MermaidSource implements the VisualSource contract. A DiagramEnvelope owns one visual source and produces an AgentProjection that exposes the render mode and structured data.

Declarative source: diagrams/sources/visual-model-classes.mmd

ER data model

Entities declare keys, fields, and cardinalities directly; agents receive the Mermaid source plus the structured data projection.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Entity
  • Primary key
  • Foreign key
  • Relationship
  • Focal
Semantic reading

A document contains sections, embeds visuals, and cites source references. Each visual renders from one declarative source identified by its language and path.

Declarative source: diagrams/sources/documentation-data-model.mmd

Quantitative line chart

The chart uses Mermaid's XY grammar, but inherits the same paper, ink, muted line, typography, and accent system as the other diagrams.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Series
  • Axis
  • Focal
Semantic reading

The illustrative corpus grows from six drafts to twenty-two published documents as content passes through review and validation.

Declarative source: diagrams/sources/document-throughput.mmd

State machine

Transitions name the event that moves a document forward or returns it for revision. Terminal markers and the focal published state remain distinct in both the diagram and its legend.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • State
  • Transition
  • Terminal
  • Focal
Semantic reading

A draft enters review, returns for changes when necessary, and can only reach publication after its contracts are validated.

Declarative source: diagrams/sources/editorial-state.mmd

Release Gantt

The schedule separates authoring, verification, and delivery while showing completed, active, and milestone treatments without adding a second visual language.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Task
  • Milestone
  • Completed
  • Active
  • Focal
Semantic reading

Authoring and source review precede contract validation and accessibility verification, ending at a publication milestone.

Declarative source: diagrams/sources/release-plan.mmd

Reader journey

Stages organize the experience from discovery to evidence. The sentiment curve makes the evidence-tracing friction explicit, while labels keep the finding understandable without relying on color.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Stage
  • Item
  • Score
  • Focal
Semantic reading

Readers discover and understand the document, encounter their main friction while tracing source evidence, and recover when the same facts are reused from the structured API.

Declarative source: diagrams/sources/reader-journey.mmd

Priority quadrant

Reader value and implementation effort place improvements in four named regions. The legend keeps axis, point, group, and focal meanings explicit.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Group
  • Item
  • Axis
  • Focal
Semantic reading

Search metadata and Mermaid examples are quick wins; API provenance is a strategic investment, while legacy screenshots and cosmetic animation rank lower.

Declarative source: diagrams/sources/documentation-priorities.mmd

Publishing dependencies

Quiet dashed groups separate sources, build, and delivery. One coral focal node carries the editorial emphasis while every connector remains individually traceable.

Diagram Design · Mermaid · drag to move · Ctrl/⌘ + scroll to zoom

100%Open full view ↗

Rendering declarative diagram…

Legend
  • Step
  • Decision
  • Group
  • Connection
  • Focal
Semantic reading

Markdown and Mermaid converge at the parser, pass one validation gate, and feed a focal projection builder that emits the human site and agent API.

Declarative source: diagrams/sources/publishing-dependencies.mmd