Write Docs
Overview
Write clear, progressive documentation for this repository using the existing Starlight + MDX docs setup. Favor stepwise examples, explicit usefulness, and consistent tone.
Workflow
- Locate the target doc or create a new MDX file under
www/src/content/docs/.
- Follow the style reference in
references/docs-style.md.
- Start each feature or API section with: what it does, why it is useful, then an example.
- Build examples incrementally (naive first, then improvements and features).
- Use Starlight code line highlighting (
ins, del, {n-m}) to emphasize changes while keeping full context.
- Keep guide content and API reference content clearly separated by headings or separate docs.
House style essentials
- Use second-person voice and consistent terminology.
- Avoid emojis, slang, or playful narration.
- Prefer short, direct sentences and descriptive headings.
References
- Read
references/docs-style.md for the full style guide and code highlighting examples.