Write Docs Skill
Create and maintain documentation for the Abacus docs site (Astro Starlight).
Before Starting
- •Read existing pages in
docs/src/content/docs/to understand patterns - •Check
docs/astro.config.mjsfor sidebar structure - •Understand the section you're adding to (getting-started, providers, cli, deployment, development)
Workflow
Adding a New Page
- •Create
.mdxfile in the appropriate directory - •Add required frontmatter (see below)
- •Use existing pages as reference for component usage
- •Run
cd docs && pnpm buildto verify
Updating an Existing Page
- •Read the current page first
- •Make changes, preserving existing patterns
- •Run
cd docs && pnpm buildto verify
Frontmatter
Every page requires:
mdx
--- title: Page Title description: One-line description for SEO sidebar: order: 1 # Position within section ---
Key Rules
Links Must Include Base Path
Internal links need /abacus/ prefix (GitHub Pages requirement):
mdx
[Quick Start](/abacus/getting-started/quick-start/) ✓ [Quick Start](/getting-started/quick-start/) ✗
Import Components Before Use
mdx
import { Steps, Aside } from '@astrojs/starlight/components';
<Steps>
1. First step
2. Second step
</Steps>
<Aside type="tip">Helpful note</Aside>
Code Blocks Need Language Tags
mdx
```bash pnpm cli sync
code
## Build Verification **Always verify before committing:** ```bash cd docs && pnpm build
Common errors:
- •Missing imports
- •Invalid frontmatter
- •Broken links (wrong path or missing
/abacus/)
Style Guidelines
- •Imperative mood ("Run this" not "You should run")
- •Code examples over abstract descriptions
- •Keep paragraphs short - users skim
- •Tables for reference data (env vars, options)