Configuration Reference

docs.config.ts lives at the project root, next to package.json:

docs.config.ts

import { defineConfig } from "trickfire-docs";

export default defineConfig({
    name: "My Project",
    description: "One-line description of the project.",
    landing: [
        { title: "Getting Started", description: "...", link: "/getting-started/" },
        { title: "Guides", description: "...", link: "/guides/writing-content/" },
        { title: "Reference", description: "...", link: "/reference/configuration/" },
        { title: "FAQ", description: "...", link: "/reference/faq/" },
    ],
    sidebar: [
        {
            label: "Guides",
            items: [{ label: "Writing Content", slug: "guides/writing-content" }],
        },
    ],
});

Field	Required	Description
name	Yes	Site title, shown in the nav, browser tab, and hero.
description	Yes	One-line summary, used as the hero tagline and meta description.
landing	Yes	Cards shown on the landing page. The first item's link is also used as the hero's "Get Started" button.
sidebar	Yes	Nav structure - same shape as Starlight's sidebar config.
social	No	Extra nav icons, appended after the fixed GitHub/Notion/TrickFire Robotics links every site always has.

The site URL and base path (docs.trickfirerobotics.com/<repo-name>) are derived automatically from package.json's "name" field and aren't configurable here. The hero's "View on GitHub" button uses the same auto-derived GitHub link.