add writing-doc-summaries skill#22664
Conversation
ti-chi-bot
bot
added
missing-translation-status
Oreoxmt
changed the title
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new AI skill, writing-doc-summaries, which provides guidelines and a workflow for generating SEO-friendly front matter summaries in Markdown files. The skill includes specific rules for character counts, opening verbs, and YAML formatting. Review feedback focused on maintaining terminology consistency by using "front matter" as two words, adhering to the repository's style guide for sentence-case headings, ensuring field names are wrapped in backticks, and adding a trailing newline to the new skill file.
.ai/AI-README.md
Outdated
|
|
||
| - `.ai/skills/review-doc-pr/`: review documentation PRs and Markdown diffs for factual accuracy, user usefulness, completeness, version fit, related-doc impact, links, and style | ||
| - `.ai/skills/create-or-update-zh-translation-pr/`: create a new docs translation PR or update an existing one by combining repo-local scripts with minimal-edit translation rules and incremental source-diff handling | ||
| - `.ai/skills/writing-doc-summaries/`: write or update the `summary` frontmatter field in a document following the repo's 115–145 character SEO-friendly sentence rules |
There was a problem hiding this comment.
Use "front matter" (two words) for consistency with line 15 of this file and general repository conventions.
| - `.ai/skills/writing-doc-summaries/`: write or update the `summary` frontmatter field in a document following the repo's 115–145 character SEO-friendly sentence rules | |
| - .ai/skills/writing-doc-summaries/`: write or update the `summary` front matter field in a document following the repo's 115–145 character SEO-friendly sentence rules |
|
|
||
| Write or improve the `summary` field in the YAML frontmatter of Markdown files in `pingcap/docs` and `pingcap/docs-cn`. | ||
|
|
||
| ## frontmatter example |
There was a problem hiding this comment.
Use sentence case for headings and use "front matter" (two words) for consistency with the repository's README.
| ## frontmatter example | |
| ## Front matter example |
References
- Use sentence case for headings (e.g., ## Configure the cluster). (link)
| - If frontmatter exists, update the `summary` line in place. | ||
| - If frontmatter is missing, add it at the top: |
There was a problem hiding this comment.
Use "front matter" (two words) instead of "frontmatter" for consistency. Also, enclose the field name summary in backticks.
| - If frontmatter exists, update the `summary` line in place. | |
| - If frontmatter is missing, add it at the top: | |
| - If front matter exists, update the `summary` line in place. | |
| - If front matter is missing, add it at the top: |
References
- Code snippets, command names, options, and paths should be in backticks. (link)
ti-chi-bot
bot
removed
the
missing-translation-status
[LGTM Timeline notifier]Timeline:
|
Co-authored-by: Grace Cai <[email protected]>
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Oreoxmt The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
2 participants
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?