BD beads-docs
Project conventions for writing, editing, restructuring, or reviewing the beads user documentation — the Mintlify site under docs/. Use this whenever you touch anything in docs/ (pages, concept docs, reference, integration guides, recovery runbooks, diagrams, docs.json navigation) or write/edit prose about beads, even when the request is just "fix the docs", "write a docs page", "the docs are wrong/confusing", "rename X across the docs", or an edit to a file under docs/. It defines the canonical concept model (bead → dependencies → ready work; formula → proto → molecule/wisp; gates; Dolt sync and federation), required terminology, the prose/emphasis/diagram conventions, the rule that generated docs are edited at their source, and the gates to run before docs work is done.
Project conventions for writing, editing, restructuring, or reviewing the beads user documentation — the Mintlify site under docs/.
As a process D 41/100 · Unfinished process — References files that are not bundled: scripts/check-cli-docs-drift.sh
How to improve
- The text references files that are not there: add them or drop the references.
- Your own cases (evals/evals.json, 4–6 real requests with expected answers): the full check would then run those instead of a model-drafted suite.
- A spec.yaml with trigger phrases and assertions — a behaviour contract for CI; `skilltest init` writes a template.
Guard findings · 0
✓ No critical or high findings
Files scanned: 4. Evidence is masked. Grey chips explain why severity was lowered.
Against the Agent Skills spec
- warning
missing-refreference to a missing file: scripts/check-cli-docs-drift.sh
Process rating: all ten parameters 41/100
- 0Tools and files. 1 referenced file(s) missing: scripts/check-cli-docs-drift.sh
- 0Result and completion. Does not say what the result is
- 0Inputs and preconditions. Does not say what the process needs to start
- 0Failures and branches. Linear process with no failure handling
- 0Progress reporting. Says nothing while it works
- 70When it triggers. States when to use, but not when not to
- 100Steps. 24 steps
- 100Consistency. Name and required fields are in place
- 100Execution cost. Instruction body is 3042 tokens
- 100Running it twice. Mutating operations check current state
- medium Safety rules and hard prohibitions inside a skill: they belong in the system prompt, here they protect nothing
- low 10 top-level sections: this looks like several domains in one skill
- low The response is described with custom markup (4 tags): a typed call is more reliable
Everything here is measured from the skill text rather than judged by a model, so the numbers are checkable. A parameter weighs more when it is a more common reason for the process to stall.
Quality signals
- +4Description does not say when NOT to use the skill (false activations)
- +3Output format is not stated: the model decides each time
- +4No input/output examples
- -5TODO / placeholder text left in the skill
- +1No license
- +2Single-language instructions
- +5Description quotes 4 example trigger phrases
- +3Description length 782: enough signal without eating the budget
- +4Structure: 11 headings
- +3Step-by-step instructions: 24 items
- +4Reference files are cited in the instructions (3 of 3)
Quality base 70; lint remarks subtract, signals add up to 100. Result: 78.