add .coderabbit.yaml

[qiancai]

What is changed, added or deleted? (Required)

This PR adds repository-level CodeRabbit configuration for documentation reviews.

• It enables automatic reviews for pull requests targeting master and release-8.5, applies an assertive review profile, and instructs CodeRabbit to provide actionable, ready-to-commit suggestions without requesting changes.
• It also uses the shared writing style as the review knowledge base and enhances it with clearer language, terminology, version-notation guidance, and a final checklist for writing, editing, and reviewing documentation.

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.

• 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)

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

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

AI agent involvement

• The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

Summary by CodeRabbit

Summary by CodeRabbit

• Documentation

  • Refined Markdown writing guidelines: narrower tone restrictions, clearer guidance when uncertain, and stricter grammar/punctuation rules.
  • Standardized present-tense writing and terminology/version-notation conventions.
  • Replaced the “review lens” section with a task-style final checklist for authored, edited, and reviewed content.

• Chores

  • Updated automated review configuration to use English (US) and focus guidance on Markdown changes.

[coderabbitai]

Warning

Review limit reached

@qiancai, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 32 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 8f3de971-963d-4cd1-b8b8-b88535bd0e3e

📥 Commits

Reviewing files that changed from the base of the PR and between 96861e2 and 2e92fa3.

📒 Files selected for processing (1)

• .coderabbit.yaml

📝 Walkthrough

Walkthrough

The PR refines Markdown writing guidance and adds CodeRabbit configuration for localized, automatic reviews of Markdown files using the updated guide.

Changes

Documentation review

Layer / File(s)	Summary
Markdown writing guidance .agents/shared/writing-style.md	Adds clarity, grammar, terminology, version-notation, and final-checklist rules for authored and reviewed Markdown content.
CodeRabbit review configuration .coderabbit.yaml	Configures review locale and behavior, automatic review branches, Markdown-specific instructions, the writing-style guideline source, and chat art settings.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

• pingcap/docs#23303: Modifies the same agent writing guide file and establishes its initial content.

Poem

A rabbit reviews with a hop and a grin,
Clearer words make the docs shine within.
Grammar stands tall, terms stay in line,
Checkboxes help every sentence align.
CodeRabbit watches the Markdown trail—
Hoppy new guidance, crisp as a quail!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately names the main change: adding the repository-level .coderabbit.yaml configuration.
Description check	✅ Passed	The description covers the required change summary and affected version, with only non-critical template sections left unfilled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[qiancai]

/approve

[ti-chi-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: qiancai

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• OWNERS [qiancai]

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