DSL Construct Reference

The archdocs YAML DSL (apiVersion: archdocs/v1) describes a document as a flat list of typed nodes plus relationships. Each node's type selects a construct:

• C4 Node - c4-node
• C4 Boundary - c4-boundary
• ERD Entity - erd-entity
• API Endpoint - api-endpoint
• Sequence Diagram - sequence-diagram
• Shape - shape
• Text - text
• Raw element - raw
• Reference - reference
• Cloud Resource - cloud-resource
• Cloud Container - cloud-container

Conversion

• Mermaid import and export

Worked example

• Cadence Platform Overview - a complete document using references, relationships and a layout hint.