Markdown Article Formatter
JimLiu/baoyu-skills
Reformats plain text or Markdown articles with frontmatter, a title, a summary, headings, bold, lists and code blocks, and saves a separate formatted copy.
Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.
Install Writing Doc Summaries
$ npx skills add pingcap/docs --skill writing-doc-summaries -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install pingcap/docs writing-doc-summaries --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/writing-doc-summaries .claude/skills/writing-doc-summaries && rm -rf skills-srcUse ~/.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/
Install the "writing-doc-summaries" agent skill from https://github.com/pingcap/docs/tree/master/.agents/skills/writing-doc-summaries into .claude/skills/writing-doc-summaries/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-doc-summaries", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/pingcap/docs/tree/master/.agents/skills/writing-doc-summariesType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add pingcap/docs --skill writing-doc-summaries -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install pingcap/docs writing-doc-summaries --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.agents/skills/writing-doc-summaries .agents/skills/writing-doc-summaries && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "writing-doc-summaries" agent skill from https://github.com/pingcap/docs/tree/master/.agents/skills/writing-doc-summaries into .agents/skills/writing-doc-summaries/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-doc-summaries", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add pingcap/docs --skill writing-doc-summaries -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install pingcap/docs writing-doc-summaries --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.agents/skills/writing-doc-summaries .cursor/skills/writing-doc-summaries && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "writing-doc-summaries" agent skill from https://github.com/pingcap/docs/tree/master/.agents/skills/writing-doc-summaries into .cursor/skills/writing-doc-summaries/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-doc-summaries", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/pingcap/docs.git --path .agents/skills/writing-doc-summaries--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add pingcap/docs --skill writing-doc-summaries -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install pingcap/docs writing-doc-summaries --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.agents/skills/writing-doc-summaries .gemini/skills/writing-doc-summaries && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "writing-doc-summaries" agent skill from https://github.com/pingcap/docs/tree/master/.agents/skills/writing-doc-summaries into .gemini/skills/writing-doc-summaries/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-doc-summaries", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install pingcap/docs writing-doc-summariesInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add pingcap/docs --skill writing-doc-summaries -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .github/skills && cp -r skills-src/.agents/skills/writing-doc-summaries .github/skills/writing-doc-summaries && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "writing-doc-summaries" agent skill from https://github.com/pingcap/docs/tree/master/.agents/skills/writing-doc-summaries into .github/skills/writing-doc-summaries/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-doc-summaries", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add pingcap/docs --skill writing-doc-summaries -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install pingcap/docs writing-doc-summaries --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/pingcap/docs.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.agents/skills/writing-doc-summaries .opencode/skills/writing-doc-summaries && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "writing-doc-summaries" agent skill from https://github.com/pingcap/docs/tree/master/.agents/skills/writing-doc-summaries into .opencode/skills/writing-doc-summaries/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "writing-doc-summaries", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
Facts
- Skill name
writing-doc-summaries- GitHub stars
- 616
- Token cost
- ~1.8k tokens
- SKILL.md length
- 787 words
- Files
- 1
- Skills in repo
- 8
- Repo updated
- First seen
- Licence
- Custom licence
At a glance
Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.
- Works in 10 steps: Length: Target 115-145 characters… → Opening verb: Start with an SEO-friendly… → Perspective: Reader-focused — tell them… → …
- A document is missing a summary
- SKILL.md covers Front matter example, Summary rules, Structure formula and Opening verb guidance, plus 4 more sections
- Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
What it does
Writing Doc Summaries is an agent skill from pingcap/docs. Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files. The summary targets 115-145 characters, with a 45-character absolute minimum. Use when a document is missing a summary, when a reviewer or CI check flags a low-quality summary, or when an existing summary is outdated, inaccurate, or the wrong length.
Its SKILL.md is about 1.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 Documents & Office, covering Markdown. 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
- A document is missing a summary
- CI check flags a low-quality summary
- An existing summary is outdated
- The wrong length
Example prompts
- “Use the writing-doc-summaries skill to write or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files”
- “/writing-doc-summaries”
Workflow steps
10 steps, taken from the first numbered list in SKILL.md.
- Length: Target 115-145 characters including spaces; 45 characters is the absolute minimum.
- Opening verb: Start with an SEO-friendly verb phrase (see Opening verb guidance) that tells the reader what they will get from this…
- Perspective: Reader-focused — tell them what they will learn or do.
- No special leading characters: Do not start with >, *, #, -, or [. If the summary must begin with a special character, wrap the entire…
- YAML quoting: Wrap the value in double quotes if it contains : or other YAML special characters.
- No redundancy: Do not repeat the document title word-for-word. Rephrase to add value.
- Language: Match the document body language. Chinese body → Chinese summary.
- Self-contained: Must be understandable without the title or body — it may appear as a standalone search snippet.
- Accuracy: Must match the actual scope of the document. Do not promise content the document does not deliver.
- Tone: Conversational but professional. No marketing language.
What it can do on your machine
Read from SKILL.md and the folder at commit 6ba8576. 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
No scripts in the folder and no shell commands in SKILL.md (its code samples are yaml).
From the folder's file list and the shell code blocks in SKILL.md.
Network
No URLs in SKILL.md.
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
Writing Doc Summaries loads about 1.8k tokens when it runs. Until then it costs about 94 tokens; SKILL.md has 787 words of instructions outside code blocks.
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 787 words (~1,753 tokens).
“Write or improve the summary field in the YAML front matter of Markdown files in pingcap/docs and pingcap/docs-cn.”
- name
- writing-doc-summaries
Files
Just SKILL.md in .agents/skills/writing-doc-summaries of pingcap/docs.
Open the folder on GitHubat commit 6ba8576
Compare with similar skills
Writing Doc Summaries 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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Writing Doc Summaries this skillpingcap/docs | 616 | — | ~1.8k | Automated safety check: Pass | Custom licence | |
| Markdown Article FormatterJimLiu/baoyu-skills | 26k | 7 repos | ~3.5k | Automated safety check: Pass | MIT | |
| MarkitdownImCa0/just-laws | 781 | 14 repos | ~3.2k | Automated safety check: Notes | MIT | |
| Obsidian MarkdownAtmosphere/atmosphere | 3.8k | 20 repos | ~1.3k | Automated safety check: Pass | Apache-2.0 | |
| Gzh Designisjiamu/gzh-design-skill | 3.9k | 1 repos | ~2.2k | Automated safety check: Pass | AGPL-3.0 | |
| Crosspostingwasp-lang/wasp | 19k | — | ~1.1k | Automated safety check: Pass | MIT |
Similar skills
Markitdown
ImCa0/just-laws
Convert files and office documents to Markdown. An agent skill from ImCa0/just-laws.
Obsidian Markdown
Atmosphere/atmosphere
Create and edit Obsidian Flavored Markdown with wikilinks, embeds, callouts, properties, and other Obsidian-specific syntax.
Gzh Design
isjiamu/gzh-design-skill
微信公众号文章排版引擎，将 Markdown 转换为可直接粘贴到公众号编辑器的 HTML。主题风格从 references/theme-index.md 注册的自定义主题库中选取，自动章节编号、关键词下划线标记、引言卡片、目录导航、代码块、图片/GIF、作者签名。支持 Markdown / Word(.docx) / PDF / 纯文本输入（非 Markdown…
Crossposting
wasp-lang/wasp
Crosspost Wasp blog articles (MDX) to DEV.to and Medium. An agent skill from wasp-lang/wasp.
- Official
Review The Docs
supabase/supabase
Review Supabase docs changes locally in your supabase/supabase checkout — either an open PR (triage, classify, verify) or your own branch before opening a PR (local self-review).
More from pingcap/docs
All 8 skills in this repoAdd Related Resources
pingcap/docs
Produces and merges Related resources cards for TiDB docs pages using the RelatedResources and ResourceCard MDX components.
Release Notes
pingcap/docs
Evaluate whether a change needs a release note. An agent skill from pingcap/docs.
Create Or Update Zh Translation PR
pingcap/docs
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…
Write Update Tidb Docs
pingcap/docs
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.
Docs Issue Metadata Guard
pingcap/docs
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.
Docs PR Metadata Guard
pingcap/docs
A skill your agent uses when creating or editing pull requests in pingcap/docs so the PR template sections, version checkboxes, related-link fields, HTML comments, and description structure stay…
Related
Works with
Categories
Questions about Writing Doc Summaries
What does Writing Doc Summaries do?
Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files. Writing Doc Summaries is an agent skill from pingcap/docs. Writes or updates the front matter summary field in pingcap/docs and pingcap/docs-cn Markdown files.
When should I use Writing Doc Summaries?
Writing Doc Summaries fits situations like: A document is missing a summary; CI check flags a low-quality summary; an existing summary is outdated; the wrong length.
How do I install Writing Doc Summaries in Claude Code?
Run `npx skills add pingcap/docs --skill writing-doc-summaries -a claude-code`. Or copy the skill folder (.agents/skills/writing-doc-summaries in pingcap/docs) into .claude/skills/writing-doc-summaries in your project. Claude Code loads it when a task matches its description.
How do I install Writing Doc Summaries in Codex?
Run `npx skills add pingcap/docs --skill writing-doc-summaries -a codex`. Or copy the skill folder (.agents/skills/writing-doc-summaries in pingcap/docs) into .agents/skills/writing-doc-summaries in your project. Codex loads it when a task matches its description.
Can I use Writing Doc Summaries 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 writing-doc-summaries -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/writing-doc-summaries, .gemini/skills/writing-doc-summaries, .github/skills/writing-doc-summaries and .opencode/skills/writing-doc-summaries in your project.
What does Writing Doc Summaries need to run?
SKILL.md names no scripts, command-line tools or credentials: Writing Doc Summaries is instructions for the agent only.
Does Writing Doc Summaries access the network?
SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.
Is Writing Doc Summaries 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 Writing Doc Summaries use?
Writing Doc Summaries 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 Writing Doc Summaries use?
About 1.8k tokens (SKILL.md is roughly 7k 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 Writing Doc Summaries?
Skills that share tags, products or a category with Writing Doc Summaries: Markdown Article Formatter (JimLiu/baoyu-skills, 26k stars), Markitdown (ImCa0/just-laws, 781 stars), Obsidian Markdown (Atmosphere/atmosphere, 3.8k stars) and Gzh Design (isjiamu/gzh-design-skill, 3.9k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
Who maintains Writing Doc Summaries?
pingcap (a GitHub organization) maintains it in pingcap/docs, which has 616 GitHub stars. The repository holds 8 skills in this directory. The repository was last updated on October 7, 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.