Comprehensive documentation review and update. Use before merging branches to ensure all docs are current, complete, and consistent.
Systematically review and update all user-facing documentation before merging a branch. This skill orchestrates the individual documentation skills into a complete pre-merge documentation audit.
Run this skill when:
Full documentation update:
/docs-update
Update specific module only:
/docs-update my-package
/docs-update --review-only
This skill follows a specific order to ensure consistency:
Run package.json review first - it's the source of truth for metadata.
# Internally runs: /docs-review-package
Check:
Apply safe fixes for metadata issues identified in review.
Generate or update the package README.
# Internally runs: /docs-generate-readme
Ensure:
Generate or update contribution guide.
# Internally runs: /docs-generate-contributing
Ensure:
Generate or update security policy.
# Internally runs: /docs-generate-security
Ensure:
If design docs exist, generate repository documentation.
# Internally runs: /docs-generate-repo (if applicable)
Ensure:
Check all internal links work:
Ensure version references are consistent:
Verify code examples:
After completion, provide a summary:
## Documentation Update Summary
### Files Updated
- ✅ README.md - Updated badges, refreshed features
- ✅ CONTRIBUTING.md - Updated Node version requirement
- ✅ SECURITY.md - No changes needed
- ⏭️ docs/ - Skipped (no design docs)
### Issues Found and Fixed
1. package.json: Added missing `bugs` field
2. README.md: Updated quick start example
3. CONTRIBUTING.md: Fixed incorrect pnpm version
### Issues Requiring Manual Review
1. README.md: Feature list may need human review
2. docs/api.md: Complex example needs verification
### Validation Results
- ✅ All internal links valid
- ✅ Version references consistent
- ⚠️ 1 example needs manual testing
This skill orchestrates:
/docs-review-package - Package.json review/docs-generate-readme - README generation/docs-generate-contributing - CONTRIBUTING.md generation/docs-generate-security - SECURITY.md generation/docs-generate-repo - Level 2 docs generation/docs-review - Documentation quality review