Documentation
README
Writing beads docs
This is the house style for docs/ — the beads user documentation, published
as a Mintlify site. The goal is docs that motivate before they jargon, say the
same thing the same way everywhere, show concepts as pictures and snippets
instead of walls of prose, and never drift from the code. Apply it to any page
you create, edit, or review.
The audience of docs/ is a user of beads — a human or agent installing
bd, tracking work, and syncing it. Contributor-facing material lives in
engdocs/ and AGENTS.md and follows different rules (it may describe the
implementation literally). When this skill says "the docs," it means docs/.
1. The canonical model
This is the opening of the README. Read the full README on GitHub.