Author MDX specifications connected to the live model, so docs and architecture stay in sync.
Specifications are the prose layer of your project: MDX pages that explain intent, decisions, and contracts. Because they can embed live model objects, workflows, and attachments, specs stay anchored to architecture instead of drifting away from it.
Docs that point at the model
A spec is not a static copy of a diagram. It embeds the live model, so when the model changes, the spec shows the current state.
What this section covers
Authoring
Write specs with MDX, frontmatter, and a clear page tree.
Embeds
Embed model objects, workflows, attachments, and diagrams.
Editing
Visual and source editing, plus a review checklist.
The authoring loop
Create a page
Add an MDX page in the right group with clear frontmatter.
Write content
Use Markdown for structure and MDX components where they add clarity.
Embed the model
Reference objects, workflows, and attachments so context stays live.
Review and publish
Check links, embeds, and metadata before sharing.
Start with plain Markdown, then add MDX components only where they improve comprehension. See the Reference for exact syntax and component props.
Last updated on