What specifically triggers a documentation warning?

It flags PRs that introduce new user-facing elements like CLI commands, UI tabs, or flight modes if no corresponding .md files or wiki updates are detected.

Can it handle multiple repositories at once?

Yes, the skill is configured to handle multiple related repositories, such as firmware and their corresponding configurator tools, in a single run.

How does it find documentation updated outside of a PR?

The skill clones the project's wiki repository and searches for commits made by the PR author within a specific time window of the PR being created or merged.

How far back does the check look?

By default, it analyzes pull requests and wiki activity from the last 7 days to provide a weekly summary of documentation status.

PR Documentation Compliance Checker

Name: PR Documentation Compliance Checker
Author: majiayu000

bymajiayu000

•

Content Management

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.

Key Features

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

Use Cases

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

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add majiayu000/claude-skill-registry check-pr-docs

For use in Claude.ai and ChatGPT

Download Skill