pingcappingcapOfficial·7 Agent Skills Included

docs

Write, review, and translate TiDB documentation with AI agents

Writes and updates TiDB documentation from code PRs, issues, and design specs. Reviews doc pull requests for factual accuracy, clarity, and style, and drafts release notes. Automates English-to-Chinese translation PRs and guards PR and issue templates. Eliminates manual copy editing, terminology drift, and broken formatting across versions.
npx skills add pingcap/docs --all -g -y
Available:

Directs the AI agent to load shared writing and translation guidance, pick the matching workflow skill for each docs task, keep edits minimal, and follow repository conventions for terminology, validation, and Git boundaries.

All Skills in This Repository (7)

Pure Emerald Level Indicators

Frequently Asked Questions

FAQPage Schema
How to install pingcap/docs skills?

Run `npx skills add pingcap/docs --all -g -y` in your terminal to install all documentation workflow skills globally.

How to write TiDB docs from a code PR?

The write-update-tidb-docs skill reads the code PR, extracts user-facing changes, and drafts or updates the correct documentation pages following repo templates.

Can AI review TiDB documentation pull requests?

Yes. The review-doc-pr skill checks factual accuracy, clarity, version fit, and links, then posts GitHub-ready committable suggestions directly on the PR.

How to translate TiDB docs from English to Chinese?

The create-or-update-zh-translation-pr skill uses bundled scripts to sync English changes into docs-cn with minimal edits and opens the translation PR automatically.

Do these skills work with Claude Code and other AI agents?

Yes. All skills follow the standard SKILL.md format and run in Claude Code, Cursor, Codex, and other compatible AI coding agents.

Related Repositories in Content & Communication

View All in Content & Communication