Skip to main content

UI System

This page tracks the internal UI authoring system for contributors and agents. It covers the governed component inventory, canonical template sources, and the generated VS Code snippets used to assemble new documentation pages.

Components

  • Governed JSX components live in snippets/components/.
  • The generated component inventory lives in docs-guide/catalog/components-catalog.mdx.
  • Component snippets are generated from docs-guide/config/component-registry.json.

Templates

The section below is generated from the canonical snippets/templates/** source tree.
Generated section: This section is synchronized by operations/scripts/generators/components/library/generate-ui-templates.js. Do not edit the generated block by hand.

Overview

  • Canonical page templates live in snippets/templates/pages/** and generate one direct preview route each.
  • Canonical block templates live in snippets/templates/blocks/** and render together on /templates/blocks/block-examples.
  • Generated authoring snippets live in .vscode/templates.code-snippets and .vscode/components.code-snippets.

Source Tree

snippets/templates

Page Templates

Block Templates

Snippets

  • Generic MDX helpers remain in .vscode/mdx.code-snippets.
  • Page/block template snippets are generated into .vscode/templates.code-snippets.
  • Component tag snippets are generated into .vscode/components.code-snippets.
Last modified on May 31, 2026