writing-doc-summaries

To write a YAML front matter summary for Markdown documentation, generate a self-contained, reader-focused summary between 115 and 145 characters that matches the document scope, language, and tone without repeating the title.

The minimum character limit for a Markdown front matter summary is 45 characters. Summaries must also fall within the 115–145 character target range to pass length requirements and comply with documentation guidelines.

To fix a missing or outdated summary in Markdown files, target the document to automatically generate a compliant summary and insert it directly into the YAML front matter, ensuring it reflects current document scope and tone.

Yes, the front matter summary must follow opening-verb guidelines. It applies these rules alongside the 45-character minimum and 115–145 character target to produce summaries that pass quality checks and ensure discoverability.

Yes, you can update summaries for Chinese Markdown documentation. The process operates on documents in both pingcap/docs and pingcap/docs-cn, generating summaries that match the specific language and tone of the targeted file.