jiayaoqijia Documentation Check Skill
Review code changes and determine if documentation updates or new documentation is needed.
Workflow
Get the code changes - Use the method provided in the prompt, or if none specified:
- For a PR:
gh pr diff <PR_NUMBER> - For local changes:
git diff mainorgit diff --staged - For a branch:
git diff main...<branch>
- For a PR:
Understand the scope - Consider what changed:
- Is this user-facing or internal?
- Does it change behavior, APIs, CLI flags, or configuration?
- Even for "internal" or "chore" changes, always verify the actual diff
Search the docs for related content in
docs/Decide what's needed:
- Do existing docs need updates to match the code?
- Is new documentation needed for undocumented features?
- Or is everything already covered?
Report findings - Use the method provided in the prompt, or if none specified, summarize findings directly
What to Check
- Accuracy: Does documentation match current code behavior?
- Completeness: Are new features/options documented?
- Examples: Do code examples still work?
- CLI/API changes: Are new flags, endpoints, or options documented?
- Configuration: Are new environment variables or settings documented?
- Breaking changes: Are migration steps documented if needed?