Authoring Docs

The rendered documentation source is the content/ directory. Every .md and .mdx file inside that tree is discovered by the content loader.

File paths become routes

Use folder index.md or index.mdx files when a section should have its own landing page.

Markdown and MDX

Use .md for straightforward prose and .mdx when you want React components in the page body. Both extensions go through the same loader, validation, ACL checks, and navigation builder.

content/
  getting-started.md
  authoring/
    index.mdx
    frontmatter.md
    navigation.md
  rendering/
    index.mdx
    components.mdx

Section pages

A section page is just an index file in a folder. It can contain normal content, or it can render a grid of its direct child pages:

Authoring rules

• Keep one topic per page.
• Use summary as the search and SEO description.
• Use nav_order for predictable menu order.
• Use nav_hidden: true for pages that should be reachable by URL but absent from menus.
• Use status: draft while writing. Drafts are hidden unless the viewer is an admin.
• Use status: deprecated when a page should remain visible with a warning banner.