Docs workflow

Source files

Write documentation in apps/goat/content/docs.

Each page is an MDX file with frontmatter:

---
title: Page title
description: One sentence summary.
---

Update apps/goat/content/docs/meta.json when adding, removing, or reordering pages.

When to update docs

Update these docs when a change affects:

• User-facing Goat behavior.
• Chat or task flow.
• Runner behavior for Goat tasks.
• Tool availability, model selection, or task planning.
• Setup, local development, or operational debugging.

Small internal refactors do not need docs unless they invalidate an existing page.

Verification

Before merging a docs change that touches MDX routing or rendering, run:

bun --filter @opencompany/goat typecheck
bun --filter @opencompany/goat build

For copy-only changes, typecheck is usually enough. For route or rendering changes, open /docs in the Goat app and click at least one nested docs page.