Getting Started: How This Guide System Works

This is a starter guide. Delete it once you’ve published real content — it exists to verify that the guide pipeline (content collection, layout, TOC, schema, and reading time) all wire together correctly.

What a guide needs

Every guide is an MDX file in src/content/guides/. The frontmatter is the contract — its shape is enforced by the schema in src/content/config.ts. The required fields are title, description, category, and publishDate.

How the table of contents works

The <GuideLayout> reads the rendered headings and lists every h2 and h3 in the sidebar. Use a logical heading hierarchy and a single h1 (the layout renders the h1 from your title for you — don’t add another).

Subheadings show up indented

Third-level headings appear nested under their parent in the table of contents.

Linking and related guides

Set related in frontmatter to other guide slugs to control the related-guides section. Leave it empty and the layout falls back to other guides in the same category, so no guide is ever orphaned.