Review and update MkDocs documentation when code changes. This skill should be used when completing feature implementation, after making code changes that affect user-facing functionality, when reviewing PRs for documentation completeness, or when auditing documentation coverage. Analyzes git diffs to identify documentation gaps and provides MkDocs Material formatting patterns.
Ensure documentation stays synchronized with code changes. Analyze git diffs, identify impacted documentation, and update MkDocs Material docs with proper formatting.
1. Analyze Changes → 2. Map to Docs → 3. Identify Gaps → 4. Update Docs → 5. Verify
Run the change analysis script or manually check:
# Using script (from project root)
python3 ~/.claude/skills/documentation-reviewer/scripts/analyze_changes.py
# Manual check
git diff --name-only HEAD~1 # or specify commit range
git diff --stat HEAD~1
| Change Type |
|---|
| Documentation Impact |
|---|
| New API endpoint | docs/api/endpoints.md |
| New feature/component | docs/features/ or docs/architecture/ |
| Config changes | docs/getting-started/ or docs/development/ |
| New invoke task | docs/development/invoke-tasks.md |
| Docker changes | docs/architecture/docker.md |
| Model changes | docs/api/endpoints.md, docs/architecture/backend.md |
| Frontend component | docs/architecture/frontend.md |
See references/change-mapping.md for complete mapping rules.
Check for missing documentation:
Use MkDocs Material syntax from references/mkdocs-material-syntax.md:
# Serve docs locally
mkdocs serve
# Check for broken links and build
mkdocs build --strict
references/mkdocs-material-syntax.md - Formatting patterns and examplesreferences/change-mapping.md - Code-to-docs mapping rulesreferences/documentation-standards.md - Writing style and structurescripts/analyze_changes.py - Git diff analysis tool