review-doc-pr

Name: review-doc-pr
Availability: InStock
Author: PingCAP

Identify factual, structural, and stylistic issues in TiDB documentation pull requests.

617|716|Updated Jul 23, 2016

Search Tags:#documentation #editing #review #pull-request #writing-style #tidb

Ready to run

npx skills add https://github.com/pingcap/docs --skill review-doc-pr

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: review-doc-pr
Source: https://github.com/pingcap/docs/tree/main/.ai/skills/review-doc-pr
Command: npx skills add https://github.com/pingcap/docs --skill review-doc-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reviews documentation PRs to ensure accuracy, completeness, and clear user guidance.

Core Features & Use Cases

Consistency checks: verify factual accuracy, terminology consistency, and alignment with version references.
Structure & clarity: assess document organization, headings, and readability to improve user comprehension.
Use Case: when a PR changes API behavior or adds new features, verify accompanying docs explain impact and version scope.

Quick Start

Review the provided PR description and diff, then return actionable, GitHub-ready feedback.

Frequently Asked Questions about review-doc-pr

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I review documentation in a pull request for factual and structural issues?▼

To review documentation in a pull request, analyze the diff to identify factual, structural, and stylistic issues. This process ensures accuracy, verifies version references, and generates GitHub-ready committable suggestions for the docs repository.

What is the best way to check TiDB docs PRs for writing style and version reference consistency?▼

Checking TiDB docs PRs for consistency involves verifying terminology, writing style, and version references against repository conventions. This ensures user-facing explanations remain clear and accurately reflect version scope.

Can I automatically generate GitHub-ready review suggestions for English documentation changes?▼

Yes, you can generate GitHub-ready review suggestions by analyzing English documentation changes within a pull request. This provides actionable, committable feedback that aligns with repository conventions and identifies stylistic issues.

Does the documentation review process verify API behavior changes and version scope?▼

Yes, the documentation review process verifies API behavior changes and version scope by examining the PR diff. It ensures accompanying docs clearly explain the feature impact and apply correct version references.

What are the limitations of automated documentation review for pull requests?▼

Automated documentation review focuses on English documentation within pingcap/docs. It identifies factual, structural, and stylistic issues but requires human oversight to validate complex technical context and nuanced user guidance.