docs-review
Skill757 starsChanged 49 days agoMITView on GitHub
Check a vortix diff for documentation it makes wrong or leaves missing, and fix the docs in the same change. Mandatory before every commit in this repo, right after ponytail-review, and part of fix-bug and release-qa. Use it whenever code, CLI flags, keys, TUI text, settings, errors, CI or scripts change, even if the user did not mention docs.
26 other projects use a version of this.
Adopted by
Most recently taken up by
- swarm-routing/skillstheir own version, first seen Nov 15, 2026
- 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
- T0mSIlver/skillstheir own version, first seen Nov 1, 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 versions26 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 26
- storybookjs/storybook★ 92ksame 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
- getsentry/sentry-rust★ 755same name
- mintlify/docs★ 465same name
- langchain-ai/docs★ 452same name
- getsentry/sentry-docs★ 450same name
16 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 repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- autopilotSkill
- fix-bugSkill
- ideateSkill
- release-changelogSkill
- release-qaSkill
The file
We split this skill into the rules it gives an agent
4 rules. 0 are common, 1 is distinctive, and 3 are very specific to this project.
0
Common
Most of the 25 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 23
Run git diff origin/main --stat and read the diff.
- Very specific: line 35
Upgrade impact: if an existing user must act, docs/MIGRATION.md and whats_new.rs (see the release-changelog skill).
- Distinctive: line 40
Every sentence must be true of the code on this branch: grep before you write.
- Very specific: line 49
Add the doc edits to the same commit as the code.
“Common” is measured: kept by at least 6 in 10 of the 25 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
The docs are read mostly by agents, who act on them without checking. A doc that is out of date is worse than a missing one. This review keeps the docs true of the diff being committed, so the fix goes in the same commit.
1. Run the mechanical check
cargo xtask check-docs && cargo test -p vortix --test suite docs_match_codeThe first covers links and anchors; the second, the subcommands and flags in docs/usage.md
and the config keys in docs/configuration.md. Fix every failure before going on.
2. Map the diff to its owners
Run git diff origin/main --stat and read the diff. For each changed surface, open its owner in
CLAUDE.md's "Docs" table and read the section it touches. Look for:
- Renamed or removed things:
rgthe old name in every*.md,.claude/skills/and the help strings in code (HELP_TEXT, clapabout/after_help,Hints). Update or delete each hit. - Changed behaviour: defaults, timeouts, limits, exit codes, JSON fields, error text, which OS a feature supports. Update the sentence that states the old behaviour; the check in step 1 does not read meaning.
- New things a user can hit: a flag, key, setting or error needs a line in its owner. An error message a user must act on also gets a troubleshooting entry.
- Moved code: paths in CLAUDE.md's "Where things live", the skills and
docs/ci-parity.md. - Upgrade impact: if an existing user must act,
docs/MIGRATION.mdandwhats_new.rs(see therelease-changelogskill).
3. Write like the existing docs
- Every sentence must be true of the code on this branch: grep before you write. A doc claim copied from a PR body or a comment is a guess.
- One owner per fact. Link to its heading instead of restating it; a second copy drifts.
- Describe what the program does now. No history ("used to", "since 0.4"), plan IDs, phase
names or roadmap promises, except in
MIGRATION.mdand the changelog. - Short, plain sentences; tables for lists of keys, flags or options.
4. Report
Add the doc edits to the same commit as the code. Then give one line per file changed, or
Docs match the diff. if nothing needed changing. If a doc change needs a product decision (for
example, whether to document a hidden flag), ask rather than guessing.
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.

