review-docs
Add or revise a handbook page so it satisfies the documentation contract and stays reachable.
- License 许可
- Apache-2.0
- 所属仓库
- BiscuitBin/knarr
- 最近更新
- 2026-11-15
- Stars
- ★ 1
- 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
- Read
AGENTS.mdanddocs/reference/documentation-contract.md. The contract is enforced byscripts/checks/validate_docs.py, whichjust docs-checkruns and which reports every violation at once. - Find the topic's owner first. Every topic in
docs/manifest.ymlhas exactly one canonical page, so prefer editing the owning page over writing a new one. - A new page needs a
docs/manifest.ymlentry whosetitle,kind,audience,canonical_forandrequiresmatch the page frontmatter exactly, including list order. The comparison is order-sensitive.requiresnames feature predicates fromchecks.toml, not related pages; knarr declares none, so it is empty. - Give the page one level-one heading identical to its
title, at least forty words of substance, and no unfinished markers, template syntax or placeholder prose. - 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. An HTML page uses manifest metadata alone and joins reachability through its anchors. - Use relative links and check the case; the contract verifies link targets exist with exact case, and heading anchors within Markdown targets. Allium modules and bootstrap evidence are not handbook pages and never enter the manifest.
- Run
just docs-check, thenjust lintfor markdownlint, typos and offline lychee, thenjust checkbefore handing back.
04 同仓库更多 Skills
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.
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.
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.
spec-change
Change an Allium specification and carry the change through the tests and the implementation.
review-docs
Add or revise a handbook page so it satisfies the documentation contract and stays reachable.
review-change
Review a change in this repository against its invariants, specifications, tests, and documentation contract.