What problem does it solve?
Writing or editing the beads user documentation (the Mintlify site under docs/) without a shared style guide leads to inconsistent terminology, prose that drifts from the actual CLI behavior, hand-edited generated files, and broken navigation. This Skill encodes the project's canonical concept model, required vocabulary, formatting rules, and verification gates so every docs change stays accurate and consistent.
Core Features & Use Cases
- Canonical concept model and terminology: Defines the official vocabulary (bead, dependency, ready work, formula, proto, molecule, wisp, gate, sync, federation) and the terms to avoid, so docs never contradict the CLI.
- Prose, formatting, and diagram conventions: Rules for Mintlify/MDX syntax, emphasis, tables, mermaid and Excalidraw diagrams, and information architecture in docs.json.
- Generated-content discipline and verification gates: Instructions to edit generated CLI docs at their Go source, plus reference guides for simplification passes, terminology renames, and pre-commit checks (docsync tests, drift checks, link checks).
- Use Case: When asked to "fix the docs", "write a docs page", or "rename a concept across the docs", the agent applies the house style, runs the verification gates, and adds redirects for moved pages.
Quick Start
Use the beads-docs conventions to review and rewrite the getting-started page under docs/ so it matches the canonical terminology and passes the docsync verification gates.