Review your first page

In this tutorial, you review a page of your Starlight site in the dev toolbar and declare its documentation type, so Compass can warn you when the page drifts.

Prerequisites

Compass installed with a provider, either TypeSafe or an OpenAI-compatible model.

Review the page

1. Start the development server:

   npm run dev

2. Open any documentation page in your browser and click the compass icon in the Astro dev toolbar at the bottom of the page.

   The Compass window shows the type the page reads like, for example “Reads like a how-to guide (92% confidence)”, and suggests declaring it.

3. Declare the suggested type in the frontmatter of the page:

   src/content/docs/guides/deploy.md

   ---
   title: Deploy your site
   diataxis: how-to
   ---

4. Save the file. The page reloads, Compass reviews it again, and the suggestion disappears.

5. To see what drift looks like, change the value to diataxis: reference and save again.

   The toolbar icon now shows a red dot, and the Compass window reports an error: the page is declared as reference but reads like a how-to guide. Set the value back to how-to when you are done.

Next steps

You reviewed a page while writing it and declared its type. From here, you can:

• Audit every page in CI to catch drift in pull requests.
• Add more rules, like quality() for rubrics or duplicates() for pages covering the same topic.
• Show documentation type badges to your readers.
• Let readers ask the docs from a sparkle button next to the search.
• Learn how Compass decides whether a page is a tutorial, a how-to guide, reference or explanation.
• Browse the configuration reference.