Skip to content

This Website

website/ is its own Astro project using the Starlight documentation theme. It is not part of the Go module and has its own bun toolchain, independent of web/.

Terminal window
cd website
bun install
bun run dev # local dev server
bun run build # static build to dist/

Content pages are markdown files under website/src/content/docs/docs/, split by section:

  • guide/ — the user-facing guide.
  • contributing/ — this section.

Every page needs frontmatter:

---
title: <Title Case, short>
description: <one sentence>
sidebar:
order: <position within its directory>
---

Starlight autogenerates a sidebar group per directory under content/docs/docs/, ordered by each page’s sidebar.order. There is no separate sidebar config file to keep in sync — add a markdown file with frontmatter and it appears.

The site’s CSS lives in website/src/styles/mono-console.css — it carries the same visual language as the product itself (see Coding Standards → Mono Console), not a separate theme.

The site deploys via Cloudflare Pages, connected directly to the GitHub repository:

Setting Value
Root directory website
Build command bun run build
Output directory dist
Production branch master

A push to master that changes anything under website/ redeploys the site; nothing else in the repository triggers a Pages build.