docs-review
Skill1 starsChanged 33 days agoMITView on GitHub
Write, edit or review a project's user docs: README, docs/ pages, CLI, server and plugin READMEs. Checks every claim against the code, gives each fact one page that the others link to, says one behaviour in one sentence wherever it appears, and trims. Use whenever a change touches docs or makes a doc claim stale, and for a docs pass after a release. Triggers: editing README.md or docs/, a renamed flag, label, default or limit, 'refresh the docs', 'review the docs'.
25 other projects use a version of this.
Adopted by
Most recently taken up by
- mintlify/docstheir own version, first seen Nov 9, 2026
- langchain-ai/docstheir own version, first seen Nov 2, 2026
- mindroom-ai/mindroomtheir own version, first seen Nov 1, 2026
- NathanForster/claude-commandstheir own version, first seen Nov 1, 2026
- microsoft/nacelletheir own version, first seen Nov 1, 2026
- grimoire-rs/grimoiretheir own version, first seen Oct 27, 2026
Used with
Projects with it also use code-review.
Other files people use alongside this one.
Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
GoogleSkillcode-review
Adversarial systems, concurrency, memory-model, and architecture code review protocol. Use this skill whenever asked to review code, PRs, diffs, or branches in Filament.
Also in 3 projects that use this
Other versions25 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 25
- storybookjs/storybook★ 91ksame name
- metabase/metabase★ 50ksame name
- grafana/tempo★ 5.6ksame name
- graphistry/pygraphistry★ 2.6ksame name
- perber/leafwiki★ 1.2ksame name
- jtenniswood/espcontrol★ 1.2ksame name
- Harry-kp/vortix★ 757same name
- getsentry/sentry-rust★ 754same name
- mintlify/docs★ 465same name
- getsentry/sentry-docs★ 449same name
15 more not listed
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository18 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- blast-radiusSkill
- claude-remote-control-serverSkill
- correctSkill
- councilSkill
- cross-reviewSkill
- evidence-bundleSkill
- herdrSkill
- intent-cardSkill
- one-termSkill
- owner-charterSkill
- quotaSkill
- starbridgeSkill
- test-auditSkill
- unnarrateSkill
- unslopSkill
- verifySkill
The file
We split this skill into the rules it gives an agent
7 rules. 0 are common, 3 are distinctive, and 4 are very specific to this project.
0
Common
Most of the 24 edited versions we read keep these.
3
Distinctive
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 13
Read the project's own docs guide first (docs/AGENTS.md, a docs section in AGENTS.md or CONTRIBUTING.md).
- Distinctive: line 23
Check each claim against the code,: never against another doc, a spec or memory.
- Distinctive: line 32
Say each behaviour in one sentence: When two products, platforms or modes behave the same, write the sentence once and put the differences …
- Very specific: line 41
Search the repo, the apps and the landing page for each renamed anchor.
- Very specific: line 42
Keep an old one that outside pages use with <a id="old-anchor"></a> above the heading.
- Distinctive: line 92
Every number, label, flag and path you touched is in the code as written.
- Very specific: line 95
Every anchor you renamed is found nowhere else, or kept with an id.
“Common” is measured: kept by at least 6 in 10 of the 24 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Docs review
Docs fail in three ways: a claim the code no longer backs, the same fact told
twice in two wordings, and text the reader can't act on. This skill catches
all three. For how sentences sound, run unnarrate and then unslop on
every paragraph you write; this skill doesn't repeat them.
Read the project's own docs guide first (docs/AGENTS.md, a docs section in
AGENTS.md or CONTRIBUTING.md). Its page map, terms and voice win over
this skill.
Happy path
- List what changed. For a pass after a release, read
git log --oneline <previous tag>..origin/mainand the decision records (spec/, ADRs) changed since. For a code change, search the docs for each name, flag, label, default and number the change touches. - Check each claim against the code, never against another doc, a spec or memory. Label: search the UI source for the exact string. Number (timeout, size, limit, default): find the constant. Flag: the CLI's help text. Version: the release list. Keep the file and line for each claim you change; the PR body cites them.
- Give each fact one home. Each page answers one reader question, and the fact lives on the page whose question it answers. Elsewhere, a few words and a link. When you find a fact on two pages, keep it on its home page and cut the other copy to a link.
- Say each behaviour in one sentence. When two products, platforms or modes behave the same, write the sentence once and put the differences beside it. Where the same behaviour must appear on several pages, copy the sentence word for word. A reworded sentence reads as a different behaviour.
- Trim. Cut what the reader can't act on: internals, history, why a decision was made (that belongs in the decision record). Paragraphs run about 3 lines.
- Keep inbound links working. Renaming a heading changes its anchor.
Search the repo, the apps and the landing page for each renamed anchor.
Keep an old one that outside pages use with
<a id="old-anchor"></a>above the heading. - Run
unnarrate, thenunslop, on the diff. - Write a short PR body: each stale claim with the file that proves the new one, what moved where, and the word count before and after.
Gotchas
- Two wordings drift apart. A fact restated on a second page doesn't get the next fix. Rule: link to its home instead. Repeat only the one sentence that names a shared behaviour, verbatim.
- Terms defined page by page. Readers meet a term on whichever page they
land on. Rule: define each term once, on the first page, and link there
(
one-termkeeps one term per thing). Keep a list order, such as the order of supported platforms, the same everywhere. - A ✓ with the catch in a footnote. Readers trust the cell. Rule: put the condition in the cell ("CLI only", "Opt-in", "With add-on").
- Claims wider than the code. "Works in X" when only X's CLI was checked. Rule: name the surfaces checked, and say "untested" for the rest.
- Claims about other tools age silently. Rule: version or date each one ("CLI 0.160 or later", "menu names from October 2026"), and link that tool's docs instead of copying them.
- Versions in examples. A pinned
v1.2.3in a clone or upgrade command goes stale every release. Rule: link the latest release, show the tag as an example, and update it on every pass. - "Since 1.4" notes. Once every supported release has the feature, the note is noise. Rule: drop it.
- UI labels from memory. Paraphrased labels send readers hunting. Rule: copy the exact string from the source and give the path, such as Settings → Notifications → Sound. Defaults and choices come from the code too: a setting the docs call opt-in may be on by default.
- A feature that changed shape. A switch that became a choice, or a "comes back at the end" that now has a mid-way path. Rule: for each release change, reread every sentence that describes the old behaviour, not only the one the PR touched.
- Maintainer content in the user path. Contract tables, CI internals and schemas stop readers where they sit. Rule: move them below the user content, or to their own page.
- No proof at the end of setup. Rule: the getting-started steps end with one that shows it works (a test message) and say what to run when it doesn't. List every file and service setup writes on the machine.
- Reviewer rewrites of picked words. Rule: a label, name or term the owner picked stays. A reviewer's rename is a proposal for the owner, not an edit.
- Docs read by agents. Each always-loaded line costs tokens on every turn. Rule: keep the steps in the main file, and move reference that only some readers need behind a link.
Checks before the PR
- Every number, label, flag and path you touched is in the code as written.
- Each fact you touched lives on one page; others link to it.
- Each shared behaviour reads the same sentence everywhere.
- Every anchor you renamed is found nowhere else, or kept with an
id. - A fresh reader, such as a model with no repo access given only the changed pages, can follow the steps to the end (reference/sources.md, "Reader test").
Not possible
- Checking another tool's UI without running it. Say "checked on
<date>with<version>" only for what you ran; for the rest, link that tool's docs.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

