docs-updater
Skill1 starsChanged 10 days agoApache-2.0View on GitHub
Detect documentation drift and patch affected docs (candidate survey, git hook, range cursor, or detect JSON). Use in conversation when the user asks to sync or update docs after code changes. Also the loop entry skill for documentation drift automation. Interactive default is survey only; edit docs when the request asks for changes to be made (for example fix, apply, or update) or automation sets agent_edit_allowed in Constraints. Not for new document creation or markdown linting.
3 other projects use a version of this.
Adopted by
Most recently taken up by
- hishamkaram/claude-code-routertheir own version, first seen Oct 27, 2026
- shenjingnan/xiaozhi-clienttheir own version, first seen Oct 8, 2026
- tomcwxyz/claude-code-templatetheir own version, first seen Feb 7, 2026
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 3
- shenjingnan/xiaozhi-client★ 341same name
- hishamkaram/claude-code-router★ 12same name
- tomcwxyz/claude-code-template★ 1same name
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 repository56 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .apm/CLAUDE.mdCLAUDE.md
- CLAUDE.mdCLAUDE.md
- .github/workflows/CLAUDE.mdCLAUDE.md
- .cursor/rules/agent-skills.mdcCursor rule
- .cursor/rules/bats.mdcCursor rule
- .cursor/rules/github-actions-workflow.mdcCursor rule
- .cursor/rules/go.mdcCursor rule
- .cursor/rules/go-test.mdcCursor rule
- .cursor/rules/instructions.mdcCursor rule
- .cursor/rules/markdown.mdcCursor rule
- .cursor/rules/shell-script.mdcCursor rule
- .cursor/rules/terraform.mdcCursor rule
- agent-skills-reviewSkill
- changelogSkill
- ci-sweeperSkill
- docs-creatorSkill
- github-actions-reviewSkill
- github-actions-validationSkill
- github-issue-autofixSkill
- github-issue-triageSkill
- github-pr-bodySkill
- github-pr-reviewSkill
- github-pr-reviseSkill
- go-reviewSkill
- go-validationSkill
- instructions-reviewSkill
- loop-verifierSkill
- markdown-validationSkill
- refactorSkill
- shell-script-reviewSkill
- shell-script-validationSkill
- tech-debtSkill
- test-gapSkill
- agent-skills-reviewSkill
- changelogSkill
- ci-sweeperSkill
- docs-creatorSkill
- docs-updaterSkill
- github-actions-reviewSkill
- github-actions-validationSkill
- github-issue-autofixSkill
- github-issue-triageSkill
- github-pr-bodySkill
- github-pr-reviewSkill
- github-pr-reviseSkill
- go-reviewSkill
- go-validationSkill
- instructions-reviewSkill
- loop-verifierSkill
- markdown-validationSkill
- refactorSkill
- shell-script-reviewSkill
- shell-script-validationSkill
- tech-debtSkill
- test-gapSkill
The file
We split this skill into the rules it gives an agent
7 rules. About 0 are common, 3 are distinctive, and 4 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
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
- Distinctive: line 37
Remove dead links; update paths for renames
- Distinctive: line 45
Run detection scripts for other skills or manage caller state
- Distinctive: line 73
When intent is unclear, survey and offer to apply — edits are harder to undo than a report.
- Very specific: line 75
When agent_edit_allowed is true, resolve agent_edit_target: on the interactive path use fix (this skill).
- Very specific: line 80
IF detect reports skip OR no documentation impact after gathering → emit survey no-op per common-output-format.md (Overview explains no-op).
- Very specific: line 82
IF agent_edit_allowed is false OR agent_edit_target is not fix → emit survey shape per common-output-format.md.
- Very specific: line 87
When detect JSON and ## Constraints are present: follow category-automation-envelope.md for edit gate, report shape, and synthesis.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
UTILITY SKILL — automated diff-sync and drift repair, not content authoring.
Input
- Interactive / hook (required): resolve scope per category-detect-scope.md — Interactive free-form →
all(full candidate docs); git hook →staged; automation cursor →rangewith--since— triage per common-impact-map.md; validate patches per common-checklist.md - Automation (optional): detect JSON in prompt — from a caller or optional skill detect script; not required for interactive runs. Read
agent_edit_allowedandagent_edit_targetfrom## Constraintsper category-automation-envelope.md; load category-input-schema.md on that path only
Path allowlist, when present, arrives in ## Constraints.
Output Specification
Report per common-output-format.md. On the automation path, also follow common-output-format-automation.md and category-automation-envelope.md. Stay within category-scope.md.
Execution Scope
Target: candidate documentation per common-impact-map.md Search Scope — typically root *.md, the repository's documentation tree, nested README.md files (excluding generated directories), and site nav config when present.
USE FOR:
- Survey candidate documentation for drift and sync opportunities (Interactive
all); update cross-references, tables, lists, and nav entries for changed paths - Remove dead links; update paths for renames
- Apply minimal documentation patches per common-checklist.md and category-documentation-maintenance.md
DO NOT USE FOR:
- New document creation or content improvement
- Non-documentation file edits
- Markdown linting
- Run detection scripts for other skills or manage caller state
Reference Files Guide
- common-checklist.md (always read)
- common-output-format.md (always read)
- common-impact-map.md (read on interactive path)
- category-documentation-maintenance.md (read when deduplication or same-change sync applies)
- category-scope.md (always read)
- category-detect-scope.md (read on interactive path)
- category-input-schema.md (read when detect JSON is present or the optional detect script is run)
- category-automation-envelope.md (read on automation path)
- common-output-format-automation.md (read on automation path)
- common-troubleshooting.md (read on failure)
- category-pr-body-links.md (read when synthesizing the PR body)
assets/pr-body-template.mdandassets/pr-body-template-survey.md(read when synthesizing the PR body)
Workflow
Resolve agent_edit_allowed before patching (git hook runs follow the Interactive rows):
| Source | agent_edit_allowed |
| Interactive — default: the request asks to look, check, triage, or survey, or only names the skill | false — survey only; do not edit documentation files |
| Interactive — the request asks for changes to be made (for example fix, apply, 修正して, 適用して, update, add) | true |
| Interactive — follow-up after a survey asking to apply | true |
Automation — ## Constraints | agent_edit_allowed: true or agent_edit_allowed: false from category-automation-envelope.md |
When intent is unclear, survey and offer to apply — edits are harder to undo than a report.
When agent_edit_allowed is true, resolve agent_edit_target: on the interactive path use fix (this skill); on the automation path read agent_edit_target from ## Constraints. Do not branch on other caller metadata outside ## Constraints.
Interactive / hook path
- Resolve scope (category-scope.md). Parse detect JSON when present; otherwise resolve the detect universe from the prompt (category-detect-scope.md), run this skill's optional detect script with the resolved
--scope(defaultallfor Interactive free-form;stagedfor git hook;rangewhen the user named a SHA range), then Agent-complement beyond mechanical output; if tools for detect are unavailable, gather changed paths from git and the user request instead of silent no-op. On detect script non-zero exit, read stdout and stop. - IF detect reports
skipOR no documentation impact after gathering → emit survey no-op per common-output-format.md (Overview explains no-op); stop. - Triage affected docs per common-impact-map.md; grep before full read.
- IF
agent_edit_allowedisfalseORagent_edit_targetis notfix→ emit survey shape per common-output-format.md; stop — do not edit documentation files or rungit add. - ELSE → apply minimal patches per common-checklist.md; when the repository maintains a generated documentation index and documentation files were created/deleted/renamed, regenerate it per UV-05; stage with
git add; emit apply shape per common-output-format.md.
Automation path
When detect JSON and ## Constraints are present: follow category-automation-envelope.md for edit gate, report shape, and synthesis. Triage and patch per common-checklist.md and category-documentation-maintenance.md. Do not manage caller state.
Error Handling
| Condition | Severity | Action |
Detect script non-zero exit or status: "error" (when invoked) | Fatal | Read stdout; stop — do not treat as success-path detect JSON |
| No git repository | Fatal | Stop |
| Empty diff / no documentation impact | Info | Emit survey no-op (Overview explains no-op); stop |
| Affected doc file missing | Recoverable | Skip file; note in report |
| Exceeds scope (>3 H2, new top-level document, etc.) | Recoverable | Stop for file; note out of scope for new top-level authoring |
mkdocs.yml missing | Recoverable | Skip nav update |
Edit requested but ## Constraints set agent_edit_allowed: false | Info | Survey only; note that the caller Constraints disallow edits |
Automation agent_edit_target mismatch | Recoverable | Survey only per category-automation-envelope.md |
Examples
- Prompt:
Sync docs after the latest commit diff - Result: Survey or apply report per references/common-output-format.md; stay within the UV-04 scope gate in references/common-checklist.md.
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.

