documentation-verification
2
总安装量
2
周安装量
#70027
全站排名
安装命令
npx skills add https://github.com/practicalswan/agent-skills --skill documentation-verification
Agent 安装分布
opencode
2
gemini-cli
2
claude-code
2
github-copilot
2
codex
2
kimi-cli
2
Skill 文档
Documentation Verification
Skill Paths
- Workspace skills:
.github/skills/ - Global skills:
C:/Users/LOQ/.agents/skills/
Activation Conditions
Use this skill when:
- Reviewing documentation before merging
- Checking documentation completeness
- Validating code examples
- Ensuring no broken links
- Verifying configuration accuracy
Before Applying Changes
Check documentation completeness:
- All new public APIs are documented
- Code examples compile and run
- Links in documentation are valid
- Configuration examples are accurate
- Installation steps are current
- README.md reflects current state
Documentation Testing
See Validation Procedures for:
- Verifying code examples compile/run
- Checking for broken internal/external links
- Validating configuration examples against schemas
- Ensuring API examples match current implementation
Validation Commands
# Example validation commands
npm run docs:check # Verify docs build
npm run docs:test-examples # Test code examples
npm run docs:lint # Check for issues
Review Checklist
- All new public APIs are documented
- Code examples compile and run
- Links in documentation are valid
- Configuration examples are accurate
- Installation steps are current
- README.md reflects current state
- No broken internal links
- No broken external references