AGENT SKILL

review-docs

Add or revise a handbook page so it satisfies the documentation contract and stays reachable.

License 许可
Apache-2.0
最近更新
2026-11-10
Stars
★ 0
Forks
0

01 前言 Front Matter

name
review-docs
description
Add or revise a handbook page so it satisfies the documentation contract and stays reachable.

03 SKILL.md 正文

Add or revise a documentation page

  1. Read AGENTS.md and docs/reference/documentation-contract.md. The contract is enforced by bg-validate-docs, which just check-docs runs and which reports every violation at once.
  2. Find the topic's owner first. Every topic in docs/manifest.yml has exactly one canonical page, so prefer editing the owning page over writing a new one.
  3. A new page needs a docs/manifest.yml entry whose title, kind, audience, canonical_for and requires match the page frontmatter exactly, including list order — the comparison is order-sensitive.
  4. Give the page one level-one heading identical to its title, at least forty words of substance, and no unfinished markers or placeholder prose.
  5. Link the page in from docs/README.md, directly or transitively. An unreachable page fails the contract even when everything else about it is correct.
  6. Use relative links and check the case; the contract verifies link targets exist with exact case, and heading anchors within Markdown targets.
  7. Run just check-docs, then just check before handoff.

04 同仓库更多 Skills

steven-cutting
steven-cutting/libpawdoku

witness

Independently witness that an Allium loop's convergence claim is true and was reached honestly. Use when the user wants to verify a loop's self-report, confirm tests really pass and no generated test was weakened, produce a convergence certificate or witness record, gate CI on a trustworthy signal, or check that an autonomous run did not cheat its way to green.

★ 0
steven-cutting
steven-cutting/libpawdoku

weed

Weed the Allium garden. Find where Allium specifications and implementation code have diverged, and help resolve the divergences. Use when the user wants to check spec-code alignment, compare specs against implementation, audit for spec drift or violations, sync specs with code or code with specs, or verify whether the implementation matches what the spec says.

★ 0
steven-cutting
steven-cutting/libpawdoku

tend

Tend the Allium garden. Use when the user wants to write, edit, update, add to, improve, clarify, refine, restructure, fix or migrate Allium specs. Covers adding entities, rules, triggers, surfaces and contracts, fixing syntax or validation errors, renaming or refactoring within specs, migrating specs to a new language version, and translating requirements into well-formed specifications. Pushes back on vague requirements.

★ 0
steven-cutting
steven-cutting/libpawdoku

spec-change

Change an Allium specification and carry the change through the tests and the implementation.

★ 0
steven-cutting
steven-cutting/libpawdoku

rust-change

Implement or review a change to the engine with the trait boundary, no_std, tests and documentation evidence the invariants require.

★ 0
steven-cutting
steven-cutting/libpawdoku

review-docs

Add or revise a handbook page so it satisfies the documentation contract and stays reachable.

★ 0