CalvinBackup/gstack
1
0
Fork 0
mirror of https://github.com/garrytan/gstack.git synced 2026-05-02 11:45:20 +02:00
Code Issues Packages Projects Releases Wiki Activity

feat: /review Step 5.6 — documentation staleness check

Browse Source 
Review skill now cross-references code changes against doc files.
If a doc describes a feature that changed but the doc wasn't updated,
flags it as INFORMATIONAL with a pointer to /document-release.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Garry Tan
2026-03-16 12:19:24 -05:00
parent 8522377a39
commit cb99316f6e
2 changed files with 28 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
review/SKILL.md
+14
View File
@@ -198,6 +198,20 @@ If TODOS.md doesn't exist, skip this step silently.
---
## Step 5.6: Documentation staleness check
Cross-reference the diff against documentation files. For each `.md` file in the repo root (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, etc.):
1. Check if code changes in the diff affect features, components, or workflows described in that doc file.
2. If the doc file was NOT updated in this branch but the code it describes WAS changed, flag it as an INFORMATIONAL finding:
"Documentation may be stale: [file] describes [feature/component] but code changed in this branch. Consider running `/document-release`."
This is informational only — never critical. The fix action is `/document-release`.
If no documentation files exist, skip this step silently.
---
## Important Rules
- **Read the FULL diff before commenting.** Do not flag issues already addressed in the diff.
review/SKILL.md.tmpl
+14
View File
@@ -124,6 +124,20 @@ If TODOS.md doesn't exist, skip this step silently.
---
## Step 5.6: Documentation staleness check
Cross-reference the diff against documentation files. For each `.md` file in the repo root (README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, etc.):
1. Check if code changes in the diff affect features, components, or workflows described in that doc file.
2. If the doc file was NOT updated in this branch but the code it describes WAS changed, flag it as an INFORMATIONAL finding:
"Documentation may be stale: [file] describes [feature/component] but code changed in this branch. Consider running `/document-release`."
This is informational only — never critical. The fix action is `/document-release`.
If no documentation files exist, skip this step silently.
---
## Important Rules
- **Read the FULL diff before commenting.** Do not flag issues already addressed in the diff.