Skip to content

docs: add write-update-tidb-docs skill#23105

Open
qiancai wants to merge 7 commits into
pingcap:masterfrom
qiancai:add-skill-write-docs
Open

docs: add write-update-tidb-docs skill#23105
qiancai wants to merge 7 commits into
pingcap:masterfrom
qiancai:add-skill-write-docs

Conversation

@qiancai

@qiancai qiancai commented Jun 18, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

This PR adds the .ai/skills/write-update-tidb-docs/ skill and registers it in AGENTS.md and .ai/AI-README.md.

The skill helps agents turn engineering and product context into user-facing TiDB documentation. It covers:

  • Accepted inputs such as code PRs, GitHub issues, product specs, design docs, rough notes, and existing docs.
  • Target-branch and documentation-impact analysis.
  • Separate workflows for creating a new documentation page and updating existing pages.
  • Validation and completion-report expectations.

Benefits:

  • Gives PM and R&D contributors a repeatable way to request docs work from implementation context.
  • Keeps AI-assisted edits aligned with repo conventions, writing style, templates, TOC placement, and validation.
  • Reduces missed related-doc impacts such as system variables, config parameters, SQL statements, and compatibility notes.
  • Keeps new-page creation and existing-page updates narrowly scoped and reviewable.

Which TiDB version(s) do your changes apply to? (Required)

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Jun 18, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new AI skill write-update-tidb-docs to assist in writing and updating TiDB documentation. It adds the main skill definition (SKILL.md), reference workflows for creating new documents (ref-create-new-doc.md) and updating existing ones (ref-update-existing-doc.md), and registers the skill in AI-README.md and AGENTS.md. The reviewer's feedback consistently points out violations of the repository style guide regarding heading capitalization, recommending that all headings, placeholders, and title guidelines use sentence case instead of title case.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread .ai/skills/write-update-tidb-docs/SKILL.md
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md Outdated
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md
Comment thread .ai/skills/write-update-tidb-docs/ref-create-new-doc.md
Comment thread .ai/skills/write-update-tidb-docs/ref-update-existing-doc.md
@qiancai qiancai self-assigned this Jun 18, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 18, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from qiancai. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot

ti-chi-bot Bot commented Jun 18, 2026

Copy link
Copy Markdown

@qiancai: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 3530080 link true /test pull-verify

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant