Overview
/snippets is the repo’s shared import namespace for reusable docs infrastructure content.
Today the canonical steady-state model is:
assets/for static files and retained support artifactscomponents/for the governed component librarycomposables/for MDX imported into other MDX pagesdata/for shared data modules, generated feed outputs, and snapshotstemplates/for copy-ready authoring scaffolds
snippets/guide.mdxis the only human-authored source of truth for snippets taxonomy and placement rulessnippets/snippets-registry.mdxis generated from the live filesystem plus folder metadata embedded in the guide
snippets/_workspace/ and snippets/automations/ are intentionally excluded from the generated root registry.
Mintlify-specific authoring and preview behaviour is governed separately in Mintlify Repo Guide.
Root Governance
snippets/guide.mdx
Use the guide for:
- folder purpose and placement rules
- how to create new snippet items
- generated versus manual ownership rules
- machine-readable folder metadata used by the registry generator
snippets/snippets-registry.mdx
The registry is generated and non-editable. It renders:
- the full live
snippets/tree - folder descriptions for every included folder
- delegated descriptions for
components/**instead of duplicating component governance
Folder Taxonomy
Placement Rules
When creating a new snippet item:- If it is
.mdximported into another.mdxpage, place it incomposables/. - If it is a data module or generated page input, place it in
data/. - If it is a static file or retained raw export, place it in
assets/. - If it is a reusable component, route it through
components/governance instead of deciding from this page. - If it is a starter scaffold, place it in
templates/.
Components Governance
components/ is governed separately.
Use:
- Component Library Overview
/docs-guide/frameworks/component-framework-canonical.mdx/snippets/components/README.md
Freshness and Generation
The snippets registry is generated by:- snippets folders move
- a new included snippets folder is added
- folder descriptions in
snippets/guide.mdxchange
Usage Patterns
Importing Components
Importing Data
Importing Composables
Related Resources
- Component Library Overview
- Automations and Workflows
/snippets/guide.mdx/snippets/snippets-registry.mdx