review-docs
Skill1 starsChanged 16 days agoMITView on GitHub
Review Jujutsu revision changes from jj show and report documentation and comments out of sync with the code.
23 other projects use a version of this.
Adopted by
Most recently taken up by
- heypinchy/pinchytheir own version, first seen Nov 6, 2026
- opensanctions/opensanctionstheir own version, first seen Nov 1, 2026
- FranciscoMoretti/chat-jstheir own version, first seen Oct 19, 2026
- Kaggle/kaggle-environmentstheir own version, first seen Oct 9, 2026
- app-dev-panel/app-dev-paneltheir own version, first seen Oct 8, 2026
- thoughtfulllc/gridlandtheir own version, first seen Oct 8, 2026
Used with
Projects with it also use create-vercel-ai-issue, dev-auth-bypass and 10 more.
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.
FranciscoMorettiSkillcreate-vercel-ai-issue
Create a well-formed GitHub issue in vercel/ai using the gh CLI. Use when reporting an AI SDK bug or preparing an issue body that contains logs, code blocks, versions, reproduction steps, and shell-sensitive text.
Also in 3 projects that use this
FranciscoMorettiSkilldev-auth-bypass
Authenticate a browser against a local ChatJS app without OAuth. Use for development login, local auth bypass, authenticated browser or Playwright testing, and the /api/dev-login route.
Also in 3 projects that use this
- +10 more from FranciscoMoretti
Other versions23 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 23
- tldraw/tldraw★ 51ksame name
- videojs/video.js★ 40ksame name
- reactjs/react.dev★ 12ksame name
- hashicorp/terraform-provider-aws★ 11ksame name
- JamieMason/syncpack★ 2.1ksame name
- OpenAEV-Platform/openaev★ 1.8ksame name
- FranciscoMoretti/chat-js★ 1.2ksame name
- FranciscoMoretti/chatjs★ 1.2ksame name
- FranciscoMoretti/sparka★ 1.2ksame name
- opensanctions/opensanctions★ 870same name
13 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 repository15 other files it gives its agents.
- audit-skill-runSkill
- challenge-handoffSkill
- dot-diagramsSkill
- handoffSkill
- implem-brakeSkill
- resume-handoffSkill
- review-auto-loopSkill
- review-correctnessSkill
- review-judgeSkill
- review-readabilitySkill
- review-testsSkill
- rust-project-maintenanceSkill
- settle-discussionSkill
- summarize-changeSkill
- web-searchSkill
The file
We split this skill into the rules it gives an agent
1 rule. 0 are common, 1 is distinctive, and 0 are very specific to this project.
0
Common
Most of the 21 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 12
Follow the common review instructions: @../review-common.md
“Common” is measured: kept by at least 6 in 10 of the 21 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
Review documentation of Jujutsu changes
Review the Jujutsu changes for the target revision, and report documentation that no longer matches the code.
Follow the common review instructions: @../review-common.md
Scope
Documentation covers:
AGENTS.md,README.md, and any other documentation file- diagrams and schemas
- code comments and docstrings
Main goals
Find documentation that:
- contradicts the code: stale command, renamed item, removed option, changed default or behavior
- describes something the change deleted
- is missing for something the change introduced, and that a reader could not guess
- lists cases where a term covering them all would serve the reader as well, above all when the change grew it by appending its own case
Also report comments and docstrings that break the rules of the "Comment and docstring style" section of AGENTS.md.
Guidelines
- Quote both the code and the documentation that contradict each other
- Fix documentation that is out of sync, only delete it when what it describes is gone
- When documentation lists cases and the change adds one, reword it around a term that covers them all rather than append the new case; keep the list only where the reader needs each case named, such as a reference of options, and never trade precision the reader needs for a vaguer term
- Be sparing with new documentation, do not propose any for its own sake
- Stay on documentation: correctness, readability and test coverage are covered by other review domains
Severity
Anchor severity to what the documentation makes its reader do:
critical— following it destroys state or costs work that cannot be recoveredmajor— it contradicts the code and sends the reader down a path that does not existminor— a style rule break, an enumeration a general term would replace, or documentation missing where the code already says it
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
Reviews can't be read right now.
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.

