beads-docs

Enforces terminology, prose, and verification conventions for the beads Mintlify documentation site.

26.8k|1.8k|Updated Oct 12, 2025
One-click install
npx skills add https://github.com/steveyegge/beads --skill beads-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: beads-docs
Source: https://github.com/steveyegge/beads/tree/main/.claude/skills/beads-docs
Command: npx skills add https://github.com/steveyegge/beads --skill beads-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about beads-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write or edit beads documentation pages correctly?

Follow the house style: lead with the problem before mechanics, use the canonical terminology (bead, proto, molecule, gate), keep pages single-purpose, and run the verification gates like go test ./test/docsync and a local Mintlify preview before committing.

How do I rename a concept across the beads docs?

Rename the concept in prose only while preserving every literal the program prints, including command names, flags, config keys, and code fence output. Never hand-edit generated files; change the Cobra strings in cmd/bd and regenerate the CLI docs instead.

Can I edit the generated CLI reference docs directly?

No. Generated files like docs/cli-reference/* and docs/CLI_REFERENCE.md must be changed at their source: edit the Short, Long, and Example strings in the Go command definitions, then run ./scripts/generate-cli-docs.sh to regenerate them.

What checks should run before committing docs changes?

Run go test ./test/docsync for navigation and link consistency, ./scripts/generate-cli-docs.sh --check for generated docs freshness, ./scripts/check-doc-freshness.sh for review markers, and preview the site with make docs-dev at localhost:3000.

What happens when I move or remove a docs page?

Add a redirect in the redirects array of docs/docs.json, rewrite inbound links across the whole repo including README and engdocs, and if the bd binary prints the old path, fix the Go source and regenerate rather than creating a pointer stub.