Frontmatter Specification
Required and optional frontmatter fields for all document types.
v2/ Content Pages (MDX)
Required
Optional (content pipeline)
OG images
Governance Documents (docs-guide/)
Required
Conditional
Component JSDoc (JSX)
7 required tags: @component, @type, @subniche, @status, @description, @accepts, @dataSource (if integrator).
See: Component Framework
Script JSDoc (JS)
11 required tags in strict order: @script, @type, @concern, @niche, @purpose, @description, @mode, @pipeline, @scope, @usage, @policy.
See: Script Framework
YAML Safety
- Always quote hex values (
'0x...') to prevent YAML number coercion
- Always quote values that could be parsed as booleans (
'true', 'false', 'yes', 'no')
- Use
>- for multi-line description strings (folded scalar, strip trailing newline)
Last modified on May 22, 2026
