{% role %}

Attributes

Parameter	Type	Required	Description
id	string	✓	Unqualified role id matching the frontmatter id (e.g., 'user')
label	string	✓	Human-readable display name shown in the UI
scope	string	—	Space-separated list of visibility scopes

Valid Children

Tag	Multiplicity
{% tldr %}	[1]
{% explanation %}	[*]
{% example %}	[*]

The role tag defines an actor or persona in the system. It captures their identity, goals, and responsibilities. Roles are referenced by flows (as actor) and stories (as the primary subject).

Agent bundle shape

Field	Source
id	id attribute
label	label attribute
description	Full prose body of the tag

Role definition with id, label, and prose description

tagroleactor role-tag-persona

{% role id="user" label="Regular User" scope="public agent" %}
A person who collects and organises web bookmarks for later reference.
They need a fast way to save URLs and retrieve them across devices.
{% /role %}

Tag Tree

{% tldr %}[1]One-sentence summary rendered as a lead paragraph and used as the document's short description throughout the site.{% explanation %}[*]Provides targeted advice or collapsible detail for a specific audience. Renders as a callout () or a disclosure element (). Supports full Markdown in the body.{% example %}[*]Embeds a named, filterable example inline in a document and collects it in the global Examples Gallery.