Skip to content

Commit 11d01b5

Browse files
committed
Merge branch 'master' into test0418
2 parents d147277 + 6beab19 commit 11d01b5

File tree

3 files changed

+79
-1
lines changed

3 files changed

+79
-1
lines changed

.gemini/config.yaml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
$schema: "http://json-schema.org/draft-07/schema#"
2+
title: RepoConfig
3+
description: Configuration for Gemini Code Assist on a repository.
4+
5+
have_fun: false # Disables fun features like poems in PR summaries
6+
7+
code_review:
8+
disable: false # Enables code reviews

.gemini/styleguide.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Documentation Review Style Guide
2+
3+
## Behavior instruction
4+
5+
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.
6+
7+
## Review aspects
8+
9+
- Clarity and simplicity
10+
- Logical flow and sentence structure
11+
- Technical accuracy and terminology consistency
12+
- Correct grammar, spelling, and punctuation
13+
14+
## General writing principles
15+
16+
- Use the **active voice** whenever possible.
17+
- Write in **second person** ("you") when addressing users.
18+
- Prefer **present tense** unless describing historical behavior.
19+
- Avoid unnecessary words and repetition.
20+
- Use **consistent terminology**. For example:
21+
22+
- ❌ Do not mix "database node" and "instance"
23+
- ✅ Stick with "TiDB instance" (or the preferred term in your glossary)
24+
25+
## Structure and format
26+
27+
- Use sentence case for headings (e.g., `## Configure the cluster`).
28+
- Use ordered lists (`1.`, `2.`) for steps.
29+
- Use bullet points (`-`) for unordered information.
30+
- Code snippets, command names, options, and paths should be in backticks (`` ` ``).
31+
- Avoid deeply nested bullet lists.
32+
33+
## Markdown style
34+
35+
- Add a blank line before and after headings and lists.
36+
- Use proper heading hierarchy (no jumping from `##` to `####`).
37+
38+
## Good examples
39+
40+
> To install TiUP, run the following command:
41+
>
42+
> ```bash
43+
> curl --proto '=https' --tlsv1.2 -sSf https://tiup.io/install.sh | sh
44+
> ```
45+
46+
> This operation drops the column permanently. Back up your data before continuing.
47+
48+
## Common issues to flag
49+
50+
- Passive voice overuse
51+
_"The cluster is started by TiUP"_ → _"TiUP starts the cluster"_
52+
53+
- Inconsistent use of technical terms
54+
_"cloud cluster" vs. "serverless cluster"_ – pick one.
55+
56+
- Unclear step instructions
57+
_"Do it like before"_ → _"Repeat step 3 using the updated config file"_
58+
59+
- Grammar and spelling issues
60+
_"recieve"_ → _"receive"_, _"an TiDB instance"_ → _"a TiDB instance"_
61+
62+
## Special notes
63+
64+
- Follow any existing terminology in our glossary (`docs/glossary.md` if available).
65+
- When in doubt, favor clarity over cleverness.
66+
- If something might confuse a new user, suggest a reword.
67+
68+
## Purpose of this style guide
69+
70+
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.

.github/workflows/doc_review.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ jobs:
7676
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7777
API_PROVIDER: "openai" # or "openai" if you want to use OpenAI
7878
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
79-
OPENAI_API_MODEL: "gpt-4o"
79+
OPENAI_API_MODEL: "gpt-4"
8080
exclude: "**/*.json" # Optional: exclude patterns separated by commas
8181
REVIEW_MODE: ${{ steps.extract.outputs.REVIEW_MODE || 'default' }}
8282
COMMIT_SHA: ${{ steps.extract.outputs.COMMIT_SHA || '' }}

0 commit comments

Comments
 (0)