{
"enums": {
"Shell": [
"standard",
"document",
"deck",
"hub"
],
"Align": [
"left",
"right",
"center"
],
"SemColor": [
"default",
"green",
"yellow",
"red",
"teal"
],
"CalloutVariant": [
"info",
"warn",
"success",
"danger"
],
"Interaction": [
"single_select",
"multi_select",
"none"
],
"CardConnector": [
"none",
"dots_line",
"arrow"
],
"BorderStyle": [
"solid",
"dashed"
],
"Direction": [
"down",
"right"
],
"TimelineStatus": [
"completed",
"active",
"upcoming"
],
"EventSeverity": [
"major",
"minor",
"info"
],
"EventFilter": [
"all",
"major"
],
"TreeStatus": [
"default",
"completed",
"active",
"blocked",
"priority",
"upcoming"
],
"TreeFilter": [
"all",
"incomplete",
"blocked",
"priority",
"overdue"
],
"ButtonVariant": [
"primary",
"secondary",
"ghost"
],
"IconSize": [
"xs",
"sm",
"md",
"lg",
"xl"
],
"AvatarSize": [
"sm",
"md",
"lg",
"xl"
],
"ChartKind": [
"pie",
"bar",
"timeseries"
],
"ChartOrientation": [
"vertical",
"horizontal"
],
"PrintFlow": [
"slides",
"continuous",
"square",
"letter"
],
"Texture": [
"none",
"dots",
"grid",
"grain",
"topography",
"diagonal"
],
"Glow": [
"none",
"accent",
"corner"
],
"Depth": [
"flat",
"soft",
"lifted"
],
"Animate": [
"none",
"fade_up",
"fade_in",
"slide_left",
"slide_right",
"stagger"
],
"NavLayout": [
"top",
"sidebar"
],
"Mode": [
"dark",
"light"
],
"AnnotationStatus": [
"pending",
"incorporated",
"ignored",
"stale"
],
"AnnotationSource": [
"cli",
"agent",
"web"
],
"RefreshMode": [
"human",
"auto",
"assisted"
],
"ThemeName": [
"dark",
"light",
"red",
"orange",
"yellow",
"green",
"blue",
"indigo",
"violet"
],
"ArchDirection": [
"left_to_right",
"top_to_bottom"
],
"GraphShape": [
"box",
"diamond",
"pill"
],
"GraphEdgeStyle": [
"solid",
"dashed"
],
"PortSide": [
"right",
"left",
"top",
"bottom"
],
"Trend": [
"up",
"down",
"flat"
],
"EventGroupBy": [
"month",
"quarter",
"source"
],
"VennView": [
"venn",
"table"
],
"QueueGroup": [
"urgency",
"horizon",
"owner",
"status",
"none"
],
"QueueHorizon": [
"now",
"next",
"later"
]
},
"types": {
"ThemeTokens": {
"bg": {
"type": "string",
"required": true,
"kind": "id"
},
"surface": {
"type": "string",
"required": true,
"kind": "id"
},
"surface_strong": {
"type": "string",
"required": true,
"kind": "id"
},
"border": {
"type": "string",
"required": true,
"kind": "id"
},
"border_strong": {
"type": "string",
"required": true,
"kind": "id"
},
"accent": {
"type": "string",
"required": true,
"kind": "id"
},
"accent_soft": {
"type": "string",
"required": true,
"kind": "id"
},
"text": {
"type": "string",
"required": true,
"kind": "id"
},
"text_muted": {
"type": "string",
"required": true,
"kind": "id"
},
"text_subtle": {
"type": "string",
"required": true,
"kind": "id"
},
"overlay_hover": {
"type": "string",
"required": true,
"kind": "id"
},
"green": {
"type": "string",
"required": true,
"kind": "id"
},
"yellow": {
"type": "string",
"required": true,
"kind": "id"
},
"red": {
"type": "string",
"required": true,
"kind": "id"
},
"header_border": {
"type": "string",
"required": true,
"kind": "id"
}
},
"MetaField": {
"key": {
"type": "string",
"required": true,
"kind": "id"
},
"value": {
"type": "string",
"required": true,
"kind": "text"
}
},
"Link": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": true,
"kind": "url"
}
},
"Badge": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"Card": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"badge": {
"type": "Badge",
"required": false,
"kind": "object"
},
"description": {
"type": "string",
"required": false,
"kind": "text"
},
"links": {
"type": "Link[]",
"required": false,
"kind": "list"
},
"href": {
"type": "string",
"required": false,
"kind": "url"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"SelectableCard": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"eyebrow": {
"type": "string",
"required": false,
"kind": "text"
},
"bullets": {
"type": "string[]",
"required": false,
"kind": "list"
},
"body": {
"type": "string",
"required": false,
"kind": "markdown"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"TimelineItem": {
"name": {
"type": "string",
"required": true,
"kind": "text"
},
"status": {
"type": "TimelineStatus",
"required": true,
"kind": "enum"
}
},
"Stat": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"value": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"trend": {
"type": "Trend",
"required": false,
"kind": "enum"
},
"previous": {
"type": "string",
"required": false,
"kind": "text"
},
"history": {
"type": "number[]",
"required": false,
"kind": "list"
}
},
"BeforeAfterItem": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"before": {
"type": "string",
"required": true,
"kind": "text"
},
"after": {
"type": "string",
"required": true,
"kind": "text"
},
"after_context": {
"type": "string",
"required": false,
"kind": "text"
}
},
"ComparePanel": {
"eyebrow": {
"type": "string",
"required": false,
"kind": "text"
},
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"stats": {
"type": "CompareStat[]",
"required": true,
"kind": "list"
}
},
"CompareStat": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"value": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"Step": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
}
},
"TableColumn": {
"key": {
"type": "string",
"required": true,
"kind": "id"
},
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"sortable": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"align": {
"type": "Align",
"required": false,
"kind": "enum"
},
"color_map": {
"type": "Record<string, SemColor>",
"required": false,
"kind": "object"
}
},
"Tab": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"components": {
"type": "Component[]",
"required": true,
"kind": "list"
}
},
"SeqStep": {
"highlight": {
"type": "string[]",
"required": false,
"kind": "list"
},
"note": {
"type": "string",
"required": false,
"kind": "markdown"
}
},
"GridChild": {
"col": {
"type": "number",
"required": false,
"kind": "layout"
},
"row": {
"type": "number",
"required": false,
"kind": "layout"
},
"colspan": {
"type": "number",
"required": false,
"kind": "layout"
},
"rowspan": {
"type": "number",
"required": false,
"kind": "layout"
},
"component": {
"type": "Component",
"required": true,
"kind": "object"
}
},
"AccordionItem": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"components": {
"type": "Component[]",
"required": true,
"kind": "list"
}
},
"EventItem": {
"date": {
"type": "string",
"required": true,
"kind": "text"
},
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"summary": {
"type": "string",
"required": false,
"kind": "markdown"
},
"severity": {
"type": "EventSeverity",
"required": false,
"kind": "enum"
},
"source": {
"type": "string",
"required": false,
"kind": "id"
},
"link": {
"type": "string",
"required": false,
"kind": "url"
},
"tags": {
"type": "string[]",
"required": false,
"kind": "list"
}
},
"TreeNode": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"status": {
"type": "TreeStatus",
"required": false,
"kind": "enum"
},
"note": {
"type": "string",
"required": false,
"kind": "text"
},
"children": {
"type": "TreeNode[]",
"required": false,
"kind": "list"
},
"owner": {
"type": "string",
"required": false,
"kind": "text"
},
"due": {
"type": "string",
"required": false,
"kind": "text"
},
"original_due": {
"type": "string",
"required": false,
"kind": "text"
}
},
"VennSet": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"VennOverlap": {
"sets": {
"type": "number[]",
"required": true,
"kind": "list"
},
"label": {
"type": "string",
"required": false,
"kind": "text"
}
},
"BreadcrumbItem": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": false,
"kind": "url"
}
},
"ButtonConfig": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": true,
"kind": "url"
},
"variant": {
"type": "ButtonVariant",
"required": false,
"kind": "enum"
},
"external": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"icon": {
"type": "string",
"required": false,
"kind": "id"
}
},
"DefinitionItem": {
"term": {
"type": "string",
"required": true,
"kind": "text"
},
"definition": {
"type": "string",
"required": true,
"kind": "markdown"
}
},
"AvatarConfig": {
"name": {
"type": "string",
"required": true,
"kind": "text"
},
"src": {
"type": "string",
"required": false,
"kind": "url"
}
},
"EmptyStateAction": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": true,
"kind": "url"
}
},
"ChartPoint": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"value": {
"type": "number",
"required": true,
"kind": "number"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"ChartSeries": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"points": {
"type": "ChartPoint[]",
"required": true,
"kind": "list"
}
},
"ResourceItem": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": true,
"kind": "url"
},
"description": {
"type": "string",
"required": false,
"kind": "text"
},
"owner": {
"type": "string",
"required": false,
"kind": "text"
}
},
"Slide": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"components": {
"type": "Component[]",
"required": true,
"kind": "list"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"eyebrow": {
"type": "string",
"required": false,
"kind": "text"
},
"subtitle": {
"type": "string",
"required": false,
"kind": "text"
},
"align": {
"type": "Align",
"required": false,
"kind": "enum"
},
"valign": {
"type": "string",
"required": false,
"kind": "id"
},
"cover": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"hide_label": {
"type": "boolean",
"required": false,
"kind": "bool"
}
},
"SourceOfTruth": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": false,
"kind": "url"
}
},
"RefreshStep": {
"run": {
"type": "string",
"required": false,
"kind": "text"
},
"prompt": {
"type": "string",
"required": false,
"kind": "text"
},
"review": {
"type": "string",
"required": false,
"kind": "text"
}
},
"RefreshConfig": {
"mode": {
"type": "RefreshMode",
"required": false,
"kind": "enum"
},
"steps": {
"type": "RefreshStep[]",
"required": false,
"kind": "list"
}
},
"Freshness": {
"updated": {
"type": "string",
"required": false,
"kind": "text"
},
"review_every": {
"type": "string",
"required": false,
"kind": "text"
},
"owner": {
"type": "string",
"required": false,
"kind": "text"
},
"sources_of_truth": {
"type": "(string | SourceOfTruth)[]",
"required": false,
"kind": "list"
},
"expires": {
"type": "string",
"required": false,
"kind": "text"
},
"refresh": {
"type": "string | RefreshConfig",
"required": false,
"kind": "object"
}
},
"Reference": {
"url": {
"type": "string",
"required": true,
"kind": "url"
},
"note": {
"type": "string",
"required": false,
"kind": "text"
}
},
"NavLink": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": false,
"kind": "url"
},
"children": {
"type": "NavLink[]",
"required": false,
"kind": "list"
},
"personas": {
"type": "string[]",
"required": false,
"kind": "list"
},
"collapsed": {
"type": "boolean",
"required": false,
"kind": "bool"
}
},
"OrgChartPerson": {
"id": {
"type": "string",
"required": false,
"kind": "id"
},
"name": {
"type": "string",
"required": true,
"kind": "text"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"email": {
"type": "string",
"required": false,
"kind": "url"
},
"linkedin": {
"type": "string",
"required": false,
"kind": "url"
},
"tags": {
"type": "OrgChartTag[]",
"required": false,
"kind": "list"
},
"reports": {
"type": "OrgChartPerson[]",
"required": false,
"kind": "list"
}
},
"OrgChartTag": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"Voice": {
"tone": {
"type": "string",
"required": false,
"kind": "id"
},
"reading_level": {
"type": "string",
"required": false,
"kind": "id"
},
"terminology": {
"type": "{ prefer?: Record<string, string>; avoid?: string[] }",
"required": false,
"kind": "object"
}
},
"Role": {
"id": {
"type": "string",
"required": true,
"kind": "id"
},
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"description": {
"type": "string",
"required": false,
"kind": "text"
},
"icon": {
"type": "string",
"required": false,
"kind": "id"
},
"href": {
"type": "string",
"required": false,
"kind": "url"
}
},
"DriftRepo": {
"prefix": {
"type": "string",
"required": true,
"kind": "id"
},
"local": {
"type": "string",
"required": false,
"kind": "id"
}
},
"DriftConfig": {
"repos": {
"type": "DriftRepo[]",
"required": true,
"kind": "list"
}
},
"ValidationError": {
"file": {
"type": "string",
"required": true,
"kind": "id"
},
"path": {
"type": "string",
"required": true,
"kind": "id"
},
"error_type": {
"type": "string",
"required": true,
"kind": "id"
},
"message": {
"type": "string",
"required": true,
"kind": "text"
},
"suggestion": {
"type": "string",
"required": false,
"kind": "text"
}
},
"Annotation": {
"id": {
"type": "string",
"required": true,
"kind": "id"
},
"text": {
"type": "string",
"required": true,
"kind": "text"
},
"author": {
"type": "string",
"required": true,
"kind": "text"
},
"section": {
"type": "string",
"required": false,
"kind": "text"
},
"added": {
"type": "string",
"required": true,
"kind": "text"
},
"status": {
"type": "AnnotationStatus",
"required": true,
"kind": "enum"
},
"source": {
"type": "AnnotationSource",
"required": true,
"kind": "enum"
}
},
"SankeyFlow": {
"source": {
"type": "string",
"required": true,
"kind": "id"
},
"target": {
"type": "string",
"required": true,
"kind": "id"
},
"value": {
"type": "number",
"required": true,
"kind": "number"
}
},
"RadarCurve": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"values": {
"type": "number[]",
"required": true,
"kind": "list"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"QuadrantPoint": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"x": {
"type": "number",
"required": true,
"kind": "layout"
},
"y": {
"type": "number",
"required": true,
"kind": "layout"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"ArchNode": {
"id": {
"type": "string",
"required": true,
"kind": "id"
},
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"icon": {
"type": "string",
"required": false,
"kind": "id"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"ArchConnection": {
"from": {
"type": "string",
"required": true,
"kind": "id"
},
"to": {
"type": "string",
"required": true,
"kind": "id"
},
"label": {
"type": "string",
"required": false,
"kind": "text"
}
},
"PipelineItem": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"dim": {
"type": "boolean",
"required": false,
"kind": "bool"
}
},
"PipelineStage": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"capabilities": {
"type": "PipelineCapability[]",
"required": false,
"kind": "list"
}
},
"PipelineCapability": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"dim": {
"type": "boolean",
"required": false,
"kind": "bool"
}
},
"GraphNode": {
"id": {
"type": "string",
"required": true,
"kind": "id"
},
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"hex": {
"type": "string",
"required": false,
"kind": "id"
},
"status": {
"type": "TimelineStatus",
"required": false,
"kind": "enum"
},
"shape": {
"type": "GraphShape",
"required": false,
"kind": "enum"
},
"group": {
"type": "string",
"required": false,
"kind": "id"
},
"width": {
"type": "number",
"required": false,
"kind": "layout"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"ports": {
"type": "PortLabel[]",
"required": false,
"kind": "list"
},
"row": {
"type": "number",
"required": false,
"kind": "layout"
},
"column": {
"type": "number",
"required": false,
"kind": "layout"
}
},
"GraphEdge": {
"from": {
"type": "string",
"required": true,
"kind": "id"
},
"to": {
"type": "string",
"required": true,
"kind": "id"
},
"label": {
"type": "string",
"required": false,
"kind": "text"
},
"style": {
"type": "GraphEdgeStyle",
"required": false,
"kind": "enum"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"GraphGroup": {
"id": {
"type": "string",
"required": true,
"kind": "id"
},
"label": {
"type": "string",
"required": false,
"kind": "text"
},
"parent": {
"type": "string",
"required": false,
"kind": "id"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"PortLabel": {
"side": {
"type": "PortSide",
"required": true,
"kind": "enum"
},
"label": {
"type": "string",
"required": true,
"kind": "text"
}
},
"HubLink": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"href": {
"type": "string",
"required": true,
"kind": "url"
}
},
"HubConfig": {
"name": {
"type": "string",
"required": true,
"kind": "text"
},
"eyebrow": {
"type": "string",
"required": false,
"kind": "text"
},
"status": {
"type": "string",
"required": false,
"kind": "text"
},
"status_color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"pages": {
"type": "HubLink[]",
"required": false,
"kind": "list"
}
},
"TableSummary": {
"group_by": {
"type": "string",
"required": true,
"kind": "id"
},
"colors": {
"type": "Record<string, SemColor>",
"required": false,
"kind": "object"
}
},
"GaugeItem": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"value": {
"type": "number",
"required": true,
"kind": "number"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"RuleItem": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"body": {
"type": "string",
"required": true,
"kind": "markdown"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"QueueItem": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"due": {
"type": "string",
"required": false,
"kind": "text"
},
"original_due": {
"type": "string",
"required": false,
"kind": "text"
},
"owner": {
"type": "string",
"required": false,
"kind": "text"
},
"status": {
"type": "TreeStatus",
"required": false,
"kind": "enum"
},
"tags": {
"type": "QueueTag[]",
"required": false,
"kind": "list"
},
"href": {
"type": "string",
"required": false,
"kind": "url"
},
"horizon": {
"type": "QueueHorizon",
"required": false,
"kind": "enum"
}
},
"QueueTag": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"emphasis": {
"type": "boolean",
"required": false,
"kind": "bool"
}
}
},
"components": {
"header": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"subtitle": {
"type": "string",
"required": false,
"kind": "text"
},
"eyebrow": {
"type": "string",
"required": false,
"kind": "text"
},
"align": {
"type": "Align",
"required": false,
"kind": "enum"
},
"id": {
"type": "string",
"required": false,
"kind": "id"
}
},
"hero_banner": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"eyebrow": {
"type": "string",
"required": false,
"kind": "text"
},
"subtitle": {
"type": "string",
"required": false,
"kind": "text"
},
"buttons": {
"type": "ButtonConfig[]",
"required": false,
"kind": "list"
}
},
"meta": {
"fields": {
"type": "MetaField[]",
"required": true,
"kind": "list"
}
},
"card_grid": {
"cards": {
"type": "Card[]",
"required": true,
"kind": "list"
},
"min_width": {
"type": "number",
"required": false,
"kind": "layout"
},
"connector": {
"type": "CardConnector",
"required": false,
"kind": "enum"
}
},
"selectable_grid": {
"cards": {
"type": "SelectableCard[]",
"required": true,
"kind": "list"
},
"interaction": {
"type": "Interaction",
"required": false,
"kind": "enum"
},
"connector": {
"type": "CardConnector",
"required": false,
"kind": "enum"
}
},
"timeline": {
"items": {
"type": "TimelineItem[]",
"required": true,
"kind": "list"
}
},
"stat_grid": {
"stats": {
"type": "Stat[]",
"required": true,
"kind": "list"
},
"columns": {
"type": "number",
"required": false,
"kind": "layout"
}
},
"before_after": {
"items": {
"type": "BeforeAfterItem[]",
"required": true,
"kind": "list"
},
"before_label": {
"type": "string",
"required": false,
"kind": "text"
},
"after_label": {
"type": "string",
"required": false,
"kind": "text"
}
},
"split_compare": {
"left": {
"type": "ComparePanel",
"required": true,
"kind": "object"
},
"right": {
"type": "ComparePanel",
"required": true,
"kind": "object"
}
},
"steps": {
"items": {
"type": "Step[]",
"required": true,
"kind": "list"
},
"numbered": {
"type": "boolean",
"required": false,
"kind": "bool"
}
},
"markdown": {
"body": {
"type": "string",
"required": true,
"kind": "markdown"
}
},
"table": {
"columns": {
"type": "TableColumn[]",
"required": true,
"kind": "list"
},
"rows": {
"type": "Record<string, unknown>[]",
"required": true,
"kind": "list"
},
"filterable": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"summary": {
"type": "TableSummary",
"required": false,
"kind": "object"
}
},
"callout": {
"variant": {
"type": "CalloutVariant",
"required": false,
"kind": "enum"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"body": {
"type": "string",
"required": true,
"kind": "markdown"
},
"links": {
"type": "ButtonConfig[]",
"required": false,
"kind": "list"
}
},
"code": {
"language": {
"type": "string",
"required": false,
"kind": "id"
},
"code": {
"type": "string",
"required": true,
"kind": "code"
}
},
"tabs": {
"tabs": {
"type": "Tab[]",
"required": true,
"kind": "list"
}
},
"section": {
"heading": {
"type": "string",
"required": false,
"kind": "text"
},
"eyebrow": {
"type": "string",
"required": false,
"kind": "text"
},
"components": {
"type": "Component[]",
"required": true,
"kind": "list"
},
"align": {
"type": "Align",
"required": false,
"kind": "enum"
},
"id": {
"type": "string",
"required": false,
"kind": "id"
}
},
"columns": {
"columns": {
"type": "Component[][]",
"required": true,
"kind": "list"
},
"equal_heights": {
"type": "boolean",
"required": false,
"kind": "bool"
}
},
"grid": {
"columns": {
"type": "number",
"required": true,
"kind": "layout"
},
"rows": {
"type": "number",
"required": false,
"kind": "layout"
},
"gap": {
"type": "number",
"required": false,
"kind": "layout"
},
"children": {
"type": "GridChild[]",
"required": true,
"kind": "list"
},
"id": {
"type": "string",
"required": false,
"kind": "id"
}
},
"box": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"tag": {
"type": "string",
"required": false,
"kind": "text"
},
"body": {
"type": "string",
"required": false,
"kind": "markdown"
},
"components": {
"type": "Component[]",
"required": false,
"kind": "list"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"hex": {
"type": "string",
"required": false,
"kind": "id"
},
"border": {
"type": "BorderStyle",
"required": false,
"kind": "enum"
},
"id": {
"type": "string",
"required": false,
"kind": "id"
}
},
"sequence": {
"target": {
"type": "string",
"required": true,
"kind": "id"
},
"steps": {
"type": "SeqStep[]",
"required": true,
"kind": "list"
},
"id": {
"type": "string",
"required": false,
"kind": "id"
}
},
"connector": {
"label": {
"type": "string",
"required": false,
"kind": "text"
},
"direction": {
"type": "Direction",
"required": false,
"kind": "enum"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
},
"hex": {
"type": "string",
"required": false,
"kind": "id"
}
},
"accordion": {
"items": {
"type": "AccordionItem[]",
"required": true,
"kind": "list"
}
},
"event_timeline": {
"events": {
"type": "EventItem[]",
"required": true,
"kind": "list"
},
"default_filter": {
"type": "EventFilter",
"required": false,
"kind": "enum"
},
"show_filter_toggle": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"limit": {
"type": "number",
"required": false,
"kind": "layout"
},
"filter_by": {
"type": "string[]",
"required": false,
"kind": "list"
},
"group_by": {
"type": "EventGroupBy",
"required": false,
"kind": "enum"
}
},
"tree": {
"nodes": {
"type": "TreeNode[]",
"required": true,
"kind": "list"
},
"default_filter": {
"type": "TreeFilter",
"required": false,
"kind": "enum"
},
"show_filter_toggle": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"default_collapsed": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"default_depth": {
"type": "number",
"required": false,
"kind": "layout"
},
"show_counts": {
"type": "boolean",
"required": false,
"kind": "bool"
}
},
"org_chart": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"people": {
"type": "OrgChartPerson[]",
"required": true,
"kind": "list"
},
"default_open_depth": {
"type": "number",
"required": false,
"kind": "layout"
}
},
"venn": {
"sets": {
"type": "VennSet[]",
"required": true,
"kind": "list"
},
"overlaps": {
"type": "VennOverlap[]",
"required": false,
"kind": "list"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"default_view": {
"type": "VennView",
"required": false,
"kind": "enum"
}
},
"image": {
"src": {
"type": "string",
"required": true,
"kind": "url"
},
"alt": {
"type": "string",
"required": false,
"kind": "text"
},
"caption": {
"type": "string",
"required": false,
"kind": "text"
},
"max_width": {
"type": "number",
"required": false,
"kind": "layout"
},
"align": {
"type": "Align",
"required": false,
"kind": "enum"
}
},
"embed": {
"src": {
"type": "string",
"required": true,
"kind": "url"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"aspect": {
"type": "string",
"required": false,
"kind": "id"
}
},
"resources": {
"items": {
"type": "ResourceItem[]",
"required": true,
"kind": "list"
}
},
"badge": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"tag": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"divider": {
"label": {
"type": "string",
"required": false,
"kind": "text"
}
},
"kbd": {
"keys": {
"type": "string[]",
"required": true,
"kind": "list"
}
},
"status": {
"label": {
"type": "string",
"required": true,
"kind": "text"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"breadcrumb": {
"items": {
"type": "BreadcrumbItem[]",
"required": true,
"kind": "list"
}
},
"button_group": {
"buttons": {
"type": "ButtonConfig[]",
"required": true,
"kind": "list"
}
},
"definition_list": {
"items": {
"type": "DefinitionItem[]",
"required": true,
"kind": "list"
}
},
"blockquote": {
"body": {
"type": "string",
"required": true,
"kind": "markdown"
},
"attribution": {
"type": "string",
"required": false,
"kind": "text"
}
},
"avatar": {
"name": {
"type": "string",
"required": true,
"kind": "text"
},
"src": {
"type": "string",
"required": false,
"kind": "url"
},
"size": {
"type": "AvatarSize",
"required": false,
"kind": "enum"
},
"subtitle": {
"type": "string",
"required": false,
"kind": "text"
}
},
"avatar_group": {
"avatars": {
"type": "AvatarConfig[]",
"required": true,
"kind": "list"
},
"size": {
"type": "AvatarSize",
"required": false,
"kind": "enum"
},
"max": {
"type": "number",
"required": false,
"kind": "layout"
}
},
"progress_bar": {
"value": {
"type": "number",
"required": true,
"kind": "number"
},
"label": {
"type": "string",
"required": false,
"kind": "text"
},
"color": {
"type": "string",
"required": false,
"kind": "id"
},
"detail": {
"type": "string",
"required": false,
"kind": "text"
},
"target": {
"type": "number",
"required": false,
"kind": "number"
},
"thresholds": {
"type": "Record<string, string>",
"required": false,
"kind": "object"
}
},
"empty_state": {
"title": {
"type": "string",
"required": true,
"kind": "text"
},
"body": {
"type": "string",
"required": false,
"kind": "markdown"
},
"action": {
"type": "EmptyStateAction",
"required": false,
"kind": "object"
},
"icon": {
"type": "string",
"required": false,
"kind": "id"
}
},
"icon": {
"name": {
"type": "string",
"required": true,
"kind": "id"
},
"size": {
"type": "IconSize",
"required": false,
"kind": "enum"
},
"color": {
"type": "SemColor",
"required": false,
"kind": "enum"
}
},
"chart": {
"kind": {
"type": "ChartKind",
"required": true,
"kind": "enum"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"x_label": {
"type": "string",
"required": false,
"kind": "text"
},
"y_label": {
"type": "string",
"required": false,
"kind": "text"
},
"orientation": {
"type": "ChartOrientation",
"required": false,
"kind": "enum"
},
"data": {
"type": "ChartPoint[]",
"required": false,
"kind": "list"
},
"series": {
"type": "ChartSeries[]",
"required": false,
"kind": "list"
}
},
"chart_group": {
"components": {
"type": "Component[]",
"required": true,
"kind": "list"
},
"columns": {
"type": "number",
"required": false,
"kind": "layout"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
}
},
"role_map": {
"title": {
"type": "string",
"required": false,
"kind": "text"
}
},
"sankey": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"flows": {
"type": "SankeyFlow[]",
"required": true,
"kind": "list"
},
"colors": {
"type": "Record<string, SemColor>",
"required": false,
"kind": "object"
}
},
"radar": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"axes": {
"type": "string[]",
"required": true,
"kind": "list"
},
"curves": {
"type": "RadarCurve[]",
"required": true,
"kind": "list"
},
"max": {
"type": "number",
"required": false,
"kind": "layout"
}
},
"quadrant": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"x_axis": {
"type": "string",
"required": true,
"kind": "text"
},
"y_axis": {
"type": "string",
"required": true,
"kind": "text"
},
"quadrants": {
"type": "string[]",
"required": true,
"kind": "list"
},
"points": {
"type": "QuadrantPoint[]",
"required": true,
"kind": "list"
}
},
"architecture": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"direction": {
"type": "ArchDirection",
"required": false,
"kind": "enum"
},
"nodes": {
"type": "ArchNode[]",
"required": true,
"kind": "list"
},
"connections": {
"type": "ArchConnection[]",
"required": true,
"kind": "list"
}
},
"pipeline": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"inputs": {
"type": "PipelineItem[]",
"required": true,
"kind": "list"
},
"stages": {
"type": "PipelineStage[]",
"required": true,
"kind": "list"
},
"outputs": {
"type": "PipelineItem[]",
"required": true,
"kind": "list"
},
"context": {
"type": "PipelineItem[]",
"required": false,
"kind": "list"
}
},
"graph": {
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"height": {
"type": "number",
"required": false,
"kind": "layout"
},
"direction": {
"type": "ArchDirection",
"required": false,
"kind": "enum"
},
"nodes": {
"type": "GraphNode[]",
"required": true,
"kind": "list"
},
"edges": {
"type": "GraphEdge[]",
"required": false,
"kind": "list"
},
"groups": {
"type": "GraphGroup[]",
"required": false,
"kind": "list"
},
"row_labels": {
"type": "(string | null)[]",
"required": false,
"kind": "list"
}
},
"aside": {
"body": {
"type": "string",
"required": true,
"kind": "markdown"
}
},
"rule_list": {
"items": {
"type": "RuleItem[]",
"required": true,
"kind": "list"
}
},
"gauge": {
"items": {
"type": "GaugeItem[]",
"required": true,
"kind": "list"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
},
"columns": {
"type": "number",
"required": false,
"kind": "layout"
},
"max": {
"type": "number",
"required": false,
"kind": "layout"
}
},
"priority_queue": {
"items": {
"type": "QueueItem[]",
"required": true,
"kind": "list"
},
"group_by": {
"type": "QueueGroup",
"required": false,
"kind": "enum"
},
"show_dates": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"show_counts": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"filterable": {
"type": "boolean",
"required": false,
"kind": "bool"
},
"title": {
"type": "string",
"required": false,
"kind": "text"
}
}
},
"guidance": {
"graph": {
"use_when": "Named nodes with relationships where position carries meaning: request paths, data flow, dependency maps. Under 12 nodes.",
"avoid_when": "Linear steps (use steps or pipeline). Strict hierarchy (use tree or org_chart). A single row of peers (use card_grid).",
"example": "graph-tiered",
"rules": [
{
"warn": "nodes > 6 && !all(nodes, row)",
"say": "Past 6 nodes, set row (and column) on every node so the layout is tiered instead of auto-placed. Auto layout overlaps at this size."
},
{
"warn": "nodes > 14",
"say": "More than 14 nodes will not read on one screen. Split into two graphs or group nodes and drop detail text."
},
{
"warn": "any(nodes, width > 160)",
"say": "Node width above 160 overlaps the 172px slot in tiered mode. Shorten the label instead."
},
{
"warn": "any(nodes, words(detail) > 24)",
"say": "Node detail wraps to 4 lines then truncates. Keep each detail under about 24 words."
},
{
"warn": "nodes > 0 && !edges",
"say": "A graph with no edges is a card_grid. Add edges or switch component."
}
]
},
"pipeline": {
"use_when": "Inputs flow through 2 to 4 stages to outputs, each stage owning a few named capabilities. Optional context strip below.",
"avoid_when": "One stage (use a box or steps). More than 4 stages (use a graph with rows, or two pipelines).",
"example": "pipeline",
"rules": [
{
"warn": "stages > 4",
"say": "Pipelines wider than 4 stages compress each stage below readable width. Split or switch to a tiered graph."
},
{
"warn": "!has(height) && stages == 3 && sum(stages[*].capabilities) > 5",
"say": "Stages stack vertically inside the height (default 400): about 48px per stage plus 42px per capability. Three stages fit about 5 capabilities total at the default; set height (9 capabilities need about 560) or trim."
},
{
"warn": "!has(height) && stages == 2 && sum(stages[*].capabilities) > 7",
"say": "Stages stack vertically inside the height (default 400): about 48px per stage plus 42px per capability. Two stages fit about 7 capabilities total at the default; set height or trim."
},
{
"warn": "!has(height) && stages >= 4 && sum(stages[*].capabilities) > 3",
"say": "Stages stack vertically inside the height (default 400): about 48px per stage plus 42px per capability. Four or more stages need an explicit height (about 48 per stage plus 42 per capability)."
},
{
"warn": "has(height) && height < 400 && sum(stages[*].capabilities) > 6",
"say": "A height under 400 with more than 6 capabilities clips the bottom stage. Raise height to about 48 per stage plus 42 per capability."
},
{
"warn": "has(context) && !has(height) && sum(stages[*].capabilities) > 4",
"say": "With a context strip the stages get 78% of the height. At the default 400 that fits about 4 capabilities total; set height to about 1.3 times the stacked size."
},
{
"warn": "stages[*].capabilities > 5",
"say": "Five capabilities per stage is the ceiling before rows truncate at the default height. Trim, dim the minor ones, or raise height."
},
{
"warn": "any(stages, words(detail) > 8)",
"say": "Stage detail is a tag line. Keep it under 8 words."
},
{
"warn": "!has(inputs) && !has(outputs)",
"say": "A pipeline needs inputs or outputs to show what flows through it."
}
]
},
"grid": {
"use_when": "Diagram-style layouts: boxes in explicit cells, connectors between rows, bands made of a box holding another grid.",
"avoid_when": "Equal-width text columns (use columns). Cards of peers (use card_grid). Metrics (use stat_grid).",
"example": "grid-diagram",
"rules": [
{
"warn": "columns > 4",
"say": "More than 4 grid columns squeezes box text. Use 2 to 4 and nest a grid inside a box for a wider band."
},
{
"warn": "children > 16",
"say": "A grid with more than 16 children is hard to scan. Split into sections or collapse detail into a table."
}
]
},
"box": {
"use_when": "A labelled panel: title left, uppercase tag right, short markdown body, optional nested components. The unit inside grid diagrams.",
"avoid_when": "Warnings or notes in prose flow (use callout). Long text (use section with markdown).",
"example": "box-band",
"rules": [
{
"warn": "words(body) > 120",
"say": "Box bodies over about 120 words stop reading as a panel. Move the prose into a markdown block and keep the box to a summary."
},
{
"warn": "words(title) > 8",
"say": "Box titles are labels. Keep them under 8 words."
},
{
"warn": "words(tag) > 3",
"say": "tag renders uppercase and right-aligned. One to three words."
}
]
},
"connector": {
"use_when": "A short grid row between two boxes showing direction, with a label on the line.",
"avoid_when": "Anything outside a grid. It fills its cell and has no meaning on its own.",
"example": "grid-diagram",
"rules": [
{
"warn": "words(label) > 7",
"say": "Connector labels sit on a thin line. Keep them under 7 words."
}
]
},
"sequence": {
"use_when": "Walking a reader through a diagram step by step: highlight a few ids per step with a one-line note.",
"avoid_when": "Pages with no target diagram. Static documents meant for print (it is hidden in export).",
"example": "sequence",
"rules": [
{
"warn": "steps > 8",
"say": "More than 8 steps loses the reader. Merge steps or split the walkthrough."
},
{
"warn": "any(steps, words(note) > 40)",
"say": "Step notes are captions. Keep each under 40 words."
},
{
"warn": "any(steps, highlight > 4)",
"say": "Highlighting more than 4 ids in one step dims almost nothing. Split the step."
}
]
},
"markdown": {
"use_when": "Prose, lists, short tables. The default when nothing structured fits.",
"avoid_when": "Anything that has a component: metrics (stat_grid), comparisons (table), steps (steps), warnings (callout).",
"rules": [
{
"warn": "words(body) > 400",
"say": "Over about 400 words in one markdown block. Split into sections with headings, or pull structure into a table, steps, or boxes."
}
]
},
"callout": {
"use_when": "One point the reader must not miss: a caveat, a decision, a rule of thumb. One or two sentences.",
"avoid_when": "Body copy. More than two callouts in a row.",
"rules": [
{
"warn": "words(body) > 80",
"say": "Callouts over about 80 words stop reading as a highlight. Trim to the point, move the rest to markdown."
}
]
},
"table": {
"use_when": "Rows that share the same fields. Comparisons, inventories, mappings.",
"avoid_when": "One row (use a definition_list or stat_grid). Cells that need paragraphs (use markdown with headings).",
"example": "table",
"rules": [
{
"warn": "columns > 6",
"say": "More than 6 columns wraps every cell. Drop columns or split into two tables."
},
{
"warn": "rows > 40 && !filterable",
"say": "Over 40 rows, set filterable: true so readers can search."
}
]
},
"chart": {
"use_when": "One series over a handful of categories or a time series. Headline numbers belong in stat_grid.",
"avoid_when": "More than 10 categories (use a table). Two unrelated metrics (use two charts).",
"example": "chart-bar",
"rules": [
{
"warn": "series[*].points > 10",
"say": "More than 10 points per series crowds the labels. Group the tail or switch to a table."
},
{
"warn": "series > 4",
"say": "More than 4 series is unreadable in one chart. Split it."
}
]
},
"stat_grid": {
"use_when": "Two to six headline metrics, each with a label, a value, and a one-line detail.",
"avoid_when": "Long labels or paragraphs (use table). A single number (use markdown or callout).",
"example": "stat_grid",
"rules": [
{
"warn": "stats > 8",
"say": "More than 8 stats is a table. Pick the six that matter."
},
{
"warn": "any(stats, words(detail) > 12)",
"say": "Stat detail is one short line. Keep it under 12 words."
}
]
},
"card_grid": {
"use_when": "Peer items with a title, a status badge, a line of description, and links: customers, projects, tools.",
"avoid_when": "Items with relationships between them (use graph). Items with many fields (use table).",
"example": "card_grid",
"rules": [
{
"warn": "cards > 12",
"say": "More than 12 cards is a directory. Use a filterable table or split by section."
},
{
"warn": "any(cards, words(description) > 30)",
"say": "Card descriptions are one or two lines. Keep them under 30 words."
}
]
},
"tree": {
"use_when": "Hierarchical work with status per node: plans, rollouts, checklists with sub-items.",
"avoid_when": "Flat lists (use steps or markdown). Org structure (use org_chart).",
"example": "tree",
"rules": [
{
"warn": "nodes > 12",
"say": "More than 12 top-level nodes; group them under parents and set default_depth so the tree opens collapsed."
}
]
},
"timeline": {
"use_when": "Ordered milestones with a status each.",
"avoid_when": "Dated events with descriptions (use event_timeline). Process steps (use steps).",
"example": "timeline",
"rules": [
{
"warn": "items > 10",
"say": "More than 10 milestones; consolidate or switch to event_timeline grouped by month."
}
]
},
"section": {
"use_when": "Grouping a page into scannable chunks with a heading. In presentation mode each top-level section is a slide.",
"avoid_when": "Wrapping a single component with no heading.",
"rules": [
{
"warn": "components > 12",
"say": "A section with more than 12 components is a page. Split it."
}
]
},
"columns": {
"use_when": "Two or three equal-width text columns.",
"avoid_when": "Boxes or diagram cells (use grid). More than three columns.",
"rules": [
{
"warn": "columns > 4",
"say": "More than 4 columns collapses on any normal width. Use grid for diagrams or a table for data."
}
]
}
}
}