Agent skill

Review Doc PR

by pingcap in pingcap/docs

Review a TiDB documentation pull request or Markdown diff for factual accuracy, user usefulness, structure, completeness, version fit, links, and repo-style issues in pingcap/docs.

Custom licenceAuto-check passedDevelopment

Install Review Doc PR

skills CLI
$ npx skills add pingcap/docs --skill review-doc-pr -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install pingcap/docs review-doc-pr --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/review-doc-pr .claude/skills/review-doc-pr && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
review-doc-pr
GitHub stars
615
Token cost
~2.8k tokens
SKILL.md length
1,553 words
Files
1
Skills in repo
8
Repo updated
First seen
Licence
Custom licence

At a glance

Review a TiDB documentation pull request or Markdown diff for factual accuracy, user usefulness, structure, completeness, version fit, links, and repo-style issues in pingcap/docs.

  • Works in 2 steps: Act as a TiDB expert and check for… → Act as a senior technical writer, check…
  • Tasks that involve Pull requests
  • SKILL.md covers Default behavior, Load this context first, Review mindset and Review priorities, plus 11 more sections
  • Calls gh

What it does

Review Doc PR is an agent skill from pingcap/docs. Review a TiDB documentation pull request or Markdown diff for factual accuracy, user usefulness, structure, completeness, version fit, links, and repo-style issues in pingcap/docs.

Its SKILL.md is about 2.8k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Pull requests. It works with TiDB. The repository describes itself as: TiDB database documentation. TiDB is an open-source, cloud-native, distributed, MySQL-Compatible database for elastic scale and real-time analytics.

When your agent uses it

  • Tasks that involve Pull requests

Example prompts

  • “/review-doc-pr”

Workflow steps

2 steps, taken from the first numbered list in SKILL.md.

  1. Act as a TiDB expert and check for technical, accuracy, logic, consistency, and user-impact issues.
  2. Act as a senior technical writer, check if the content is clear, concise, and easy to understand, and review the document against the…

What it can do on your machine

Read from SKILL.md and the folder at commit c90b204. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • gh

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md. Its commands use gh, which can reach the network depending on how they are called.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Review Doc PR loads about 2.8k tokens when it runs. Until then it costs about 49 tokens; SKILL.md has 1,553 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~49
When it runs · the whole SKILL.md, loaded when a task matches
~2.8k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

Its licence (Custom licence) doesn't allow us to republish the file, so here is its outline and opening line. It has 1,553 words (~2,801 tokens).

“Use this skill when the task is to review a documentation PR, a Markdown diff, or changed documentation content in pingcap/docs.”

— opening of SKILL.md by pingcap, Custom licence
name
review-doc-pr

Read the full SKILL.md on GitHub

Files

Just SKILL.md in .agents/skills/review-doc-pr of pingcap/docs.

Open the folder on GitHubat commit c90b204

Compare with similar skills

Review Doc PR next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Review Doc PR compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Review Doc PR this skillpingcap/docs615—~2.8kAutomated safety check: PassCustom licence
TiDB Change Instruction Criticpingcap/tidb41k—~523Automated safety check: PassApache-2.0
TiDB PR Metadata Guardpingcap/tidb41k—~703Automated safety check: PassApache-2.0
Finishing a Development Branchobra/superpowers297k5 repos~1.9kAutomated safety check: PassMIT
PR Babysitteropeninterpreter/openinterpreter69k3 repos~4.2kAutomated safety check: PassApache-2.0
Check PRonyx-dot-app/onyx32k2 repos~2.3kAutomated safety check: PassMIT

Similar skills

  • Checks a fix proposed by a user or reviewer for intent, correctness and compatibility before the agent implements it in the TiDB codebase.

    41k GitHub stars~523 tokensUpdated today
    DevelopmentAuto-check passed
  • Creates and edits TiDB pull request titles and descriptions without breaking the PR template, and diagnoses bot labels that stay on because of template changes.

    41k GitHub stars~703 tokensUpdated today
    DevelopmentAuto-check passed
  • Walks the last step of a branch: confirm tests pass, detect the git environment, ask how to integrate, carry out your choice and clean up the worktree.

    297k GitHub starsUsed in 5 repos~1.9k tokens
    DevelopmentAuto-check passed
  • PR Babysitter

    openinterpreter/openinterpreter

    Watches an open GitHub pull request until it merges, handling review comments, diagnosing CI failures and retrying flaky checks along the way.

    69k GitHub starsUsed in 3 repos~4.2k tokens
    DevelopmentAuto-check passed
  • Check PR

    onyx-dot-app/onyx

    Checks a GitHub, GitLab, or Perforce (p4) pull request (or merge request, or shelved changelist) for unresolved review comments, failing status checks, and incomplete PR descriptions.

    32k GitHub starsUsed in 2 repos~2.3k tokens
    DevelopmentAuto-check passed
  • PR Design Doc

    OpenHands/OpenHands

    For a non-trivial pull request, write a self-contained HTML design doc under the temporary .pr/ directory and link a visibility-appropriate preview in the PR description, so maintainers grasp the…

    90k GitHub stars~2.4k tokensUpdated today
    DevelopmentAuto-check passed

More from pingcap/docs

All 8 skills in this repo
  • Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.

    615 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • Release Notes

    pingcap/docs

    Evaluate whether a change needs a release note. An agent skill from pingcap/docs.

    615 GitHub stars~2.6k tokensUpdated today
    Auto-check passed
  • Create or update a zh translation PR from pingcap/docs to pingcap/docs-cn by using repo-local scripts to prepare change-unit translation inputs, apply minimal edits to the existing Chinese files…

    615 GitHub stars~2.9k tokensUpdated today
    Auto-check passed
  • Write new TiDB documentation or update existing TiDB documentation from code changes, PRs, issues, design docs, product specs, rough drafts, existing docs, or short feature descriptions.

    615 GitHub stars~2.3k tokensUpdated today
    Auto-check passed
  • Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.

    615 GitHub stars~1.8k tokensUpdated today
    Auto-check passed
  • A skill your agent uses when creating or editing GitHub issues in pingcap/docs so issue templates, required fields, scope boundaries, and labels stay consistent with repository workflow.

    615 GitHub stars~1.8k tokensUpdated today
    Auto-check passed

Works with

Categories

Questions about Review Doc PR

What does Review Doc PR do?

Review a TiDB documentation pull request or Markdown diff for factual accuracy, user usefulness, structure, completeness, version fit, links, and repo-style issues in pingcap/docs. Review Doc PR is an agent skill from pingcap/docs. Review a TiDB documentation pull request or Markdown diff for factual accuracy, user usefulness, structure, completeness, version fit, links, and repo-style issues in pingcap/docs.

When should I use Review Doc PR?

Review Doc PR fits situations like: tasks that involve Pull requests.

How do I install Review Doc PR in Claude Code?

Run `npx skills add pingcap/docs --skill review-doc-pr -a claude-code`. Or copy the skill folder (.agents/skills/review-doc-pr in pingcap/docs) into .claude/skills/review-doc-pr in your project. Claude Code loads it when a task matches its description.

How do I install Review Doc PR in Codex?

Run `npx skills add pingcap/docs --skill review-doc-pr -a codex`. Or copy the skill folder (.agents/skills/review-doc-pr in pingcap/docs) into .agents/skills/review-doc-pr in your project. Codex loads it when a task matches its description.

Can I use Review Doc PR in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add pingcap/docs --skill review-doc-pr -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/review-doc-pr, .gemini/skills/review-doc-pr, .github/skills/review-doc-pr and .opencode/skills/review-doc-pr in your project.

What does Review Doc PR need to run?

Going by SKILL.md and its folder, Review Doc PR needs the command-line tools its instructions call (gh).

Does Review Doc PR access the network?

SKILL.md contains no URLs. Its commands use gh, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Review Doc PR safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Review Doc PR use?

Review Doc PR has a licence file (the repository's licence) that doesn't match a standard licence. Read it on GitHub before reusing the skill.

How many tokens does Review Doc PR use?

About 2.8k tokens (SKILL.md is roughly 11k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Review Doc PR?

Skills that share tags, products or a category with Review Doc PR: TiDB Change Instruction Critic (pingcap/tidb, 41k stars), TiDB PR Metadata Guard (pingcap/tidb, 41k stars), Finishing a Development Branch (obra/superpowers, 297k stars) and PR Babysitter (openinterpreter/openinterpreter, 69k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Review Doc PR?

pingcap (a GitHub organization) maintains it in pingcap/docs, which has 615 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 9, 2026.

Source: pingcap/docs on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.