Skip to content

Description

Descriptions describe definitions. You can add a description to any kind of definition. Descriptions are written in Markdown format and can include mermaid diagrams and other Markdown features supported by the documentation renderer. Descriptions can also be provided in separate files and via public (no password required) HTTP URLs.

Occurs On

Every kind of definition.

Contains

Markdown text either directly in RIDDL, in a file, or via a URL.