Embed a workflow's sequence diagram in a spec.
The Workflow component embeds an existing workflow’s sequence diagram. It renders behavior — the ordered messages between objects — for a given model and workflow id.
Basic usage
<Workflow model_key="logic" workflow_id="release-pipeline" />| Prop | Required | Purpose |
|---|---|---|
model_key | Yes (in specs) | Model context for the workflow |
workflow_id | Yes | The workflow to render (<id>.wf) |
attachment_key | No | Optional attachment tab key (defaults to workflow_id) |
It renders an existing workflow
Workflow does not accept hand-authored stages. It renders a workflow
defined in the model. Define the workflow first, then embed it by id.
Pattern: process documentation
Define the workflow
Create the workflow in the model (see Modeling → Workflows).
Embed it in the spec
Reference it by model_key and workflow_id.
Explain around it
Add prose for preconditions, edge cases, and rationale the diagram cannot show.
Pair the embedded diagram with a short narrative. The diagram shows the sequence; the prose explains the why. See Workflow component reference.
Last updated on