PR Documentation Compliance Checker
Analyzes pull requests and wiki commits to verify that code changes are accompanied by appropriate documentation updates.
The Check PR Documentation Compliance skill is designed for project maintainers and documentation teams to ensure project health and maintainability. It scans pull requests from the last seven days, analyzing file diffs for user-facing changes like new CLI commands or UI features. Crucially, it goes beyond the repository by cloning and parsing independent GitHub Wiki commits to cross-reference updates made outside the PR workflow, ensuring that documentation is tracked even when managed in separate repositories.
주요 기능
01Detection of documentation references in PR descriptions and comments
02Smart detection of documentation-heavy changes like new CLI commands or MSP messages
0364 GitHub stars
04Automated scanning of recent pull requests across multiple repositories
05Independent verification of GitHub Wiki commits and author cross-referencing
06Detailed markdown report generation for documentation auditing
사용 사례
01Ensuring that wiki updates are correctly mapped to corresponding feature PRs
02Automating documentation audits during open-source project release cycles
03Identifying 'documentation debt' by flagging feature-rich PRs lacking doc updates