Skills
.Work. You
Rest

review-doc-pr

Official

Turn PRs into ready-to-commit doc feedback.

Content & Communication#documentation#editing#review#pull-request#writing-style#tidb
Authorpingcap
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: review-doc-pr
Download link: https://github.com/pingcap/docs/archive/main.zip#review-doc-pr

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.