write-docs

# Documentation Treat implementation, types, tests, and content schemas as factual sources. Read `site/src/content/docs/writing-style/write-guides.mdx` before authoring a site guide. ## Choose the artifact Before drafting, write down the shape (how-to or concept), the reader's question, and the compass quadrant it serves (action or cognition, study or work). Both shapes live in `site/src/content/docs/guides/`; exact API and error-code descriptions live under `reference/`, and `pnpm -F site test diataxis` guards that line. - Achieve a specific outcome with the player (autoplay, captions, self-hosting): how-to guide. Keep only the explanation needed to complete or adapt that task. - Reusable mental model or rationale that helps with several tasks: concept page. Do not create a concept page for background that belongs to one how-to. - Package install and entry points: package README - Non-obvious public contract at the symbol: JSDoc - Exact component, feature, hook, utility, option, state surface, or error code: reference page. Update its owning TypeScript or registry source rather than duplicating exhaustive detail in a guide. ## Workflow 1. Identify the audience, question, and owning source files. 2. Read neighboring docs for current voice and MDX patterns. 3. Load only what applies: - Voice and structure: `references/writing-style.md` - Content drifting between document types, or per-type tone and sentence forms: `references/diataxis.md` - SEO-sensitive site content: `references/seo.md` - State/tooling concepts: `references/state-tooling.md` - Component-library comparisons: `references/component-libraries.md` - Code or error examples: the matching file in `patterns/` - New artifact scaffold: the matching file in `templates/` 4. Lead with the user outcome or concept. Use complete, verified examples and explain only non-obvious parts. 5. Reread the draft against `references/diataxis.md`: every heading and sentence form matches the shape you chose. Move passages that read like another shape to the page that owns them and leave a link. 6. Add the sidebar entry and framework/style restrictions for new site pages. When a page changes slug, add a `[[redirects]]` rule for the old URL and its `.md` twin to `site/netlify.toml`, above the section-wide rules. 7. Run examples or relevant tests where practical, run `pnpm -F site test diataxis` for site pages, and render affected MDX for every supported variant. Do not duplicate signatures TypeScript already expresses. API-builder exports are the exception when its tests require structured JSDoc fields. ## Example Input: “Write a guide for configuring captions.” Output: A task-oriented page with verified examples, the correct sidebar metadata, and rendered MDX validation.