Writing Doc Summaries

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.

pingcap Updated 5 repo stars
image

File contents

pingcap/docs-staging commit ebdee255f2

Frequently asked questions

npx get-skill add pingcap/writing-doc-summaries