You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/scripts/auto-fix-review.sh
+7-2Lines changed: 7 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ OUTPUT=$(evot -p "You are addressing review feedback on a documentation PR.
43
43
44
44
PR #${PR_NUMBER}: ${PR_TITLE}
45
45
46
-
The Databend source code is available at _databend/src/ for reference.
46
+
The Databend source code is available at _databend/src/ for reference. Check _databend/RELEASES.txt for recent release tags to determine version numbers.
47
47
48
48
## Inline review comments:
49
49
${FORMATTED}
@@ -60,7 +60,12 @@ Task:
60
60
Rules:
61
61
- Only modify files under docs/en/ and docs/cn/.
62
62
- Do NOT run git, gh, or any shell commands that modify the repository state.
63
-
- The CI script handles git commit, push, and PR replies." \
63
+
- The CI script handles git commit, push, and PR replies.
64
+
- Analyze the Databend source code in _databend/src/ and release tags to determine which version introduced or updated the feature being documented. Then add or update the FunctionDescription component at the top of the doc (after the frontmatter):
65
+
For docs/en/: import FunctionDescription from '@site/src/components/FunctionDescription'; then <FunctionDescription description=\"Introduced or updated: vX.Y.Z\"/>
66
+
For docs/cn/: import FunctionDescription from '@site/src/components/FunctionDescription'; then <FunctionDescription description=\"引入或更新于:vX.Y.Z\"/>
67
+
If the doc already has a FunctionDescription, update the version if the change is newer.
68
+
- Keep documentation concise and clear. If a setting defaults to true (enabled), do not document it separately — only mention settings that users need to explicitly change." \
Copy file name to clipboardExpand all lines: .github/scripts/auto-fix.sh
+6-1Lines changed: 6 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ GEN_RAW=$(evot -p "You are fixing a documentation issue in the databend-docs rep
71
71
72
72
Task:
73
73
1. Read the issue carefully and understand what documentation is missing or wrong.
74
-
2. Look at _databend/src/ for the actual Databend source code to verify implementation details.
74
+
2. Look at _databend/src/ for the actual Databend source code to verify implementation details. Check _databend/RELEASES.txt for recent release tags to determine version numbers.
75
75
3. Read existing docs under docs/en/ to match the style and find the right location.
76
76
4. Make the fix in docs/en/.
77
77
5. If you modified any file under docs/en/, also update the corresponding file under docs/cn/ (Chinese translation). Keep technical terms in English, translate descriptions to Chinese.
@@ -80,6 +80,11 @@ Rules:
80
80
- Only modify files under docs/en/ and docs/cn/.
81
81
- Do NOT run git, gh, or any shell commands that modify the repository state.
82
82
- The CI script handles git commit, push, and PR creation.
83
+
- Analyze the Databend source code in _databend/src/ and release tags to determine which version introduced or updated the feature being documented. Then add or update the FunctionDescription component at the top of the doc (after the frontmatter):
84
+
For docs/en/: import FunctionDescription from '@site/src/components/FunctionDescription'; then <FunctionDescription description=\"Introduced or updated: vX.Y.Z\"/>
85
+
For docs/cn/: import FunctionDescription from '@site/src/components/FunctionDescription'; then <FunctionDescription description=\"引入或更新于:vX.Y.Z\"/>
86
+
If the doc already has a FunctionDescription, update the version if the change is newer.
87
+
- Keep documentation concise and clear. If a setting defaults to true (enabled), do not document it separately — only mention settings that users need to explicitly change.
0 commit comments