chore: add Ai doc workflow #24320
Open
chore: add Ai doc workflow #24320
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hzxa21
reviewed
Jan 5, 2026
Collaborator
hzxa21
left a comment
hzxa21
left a comment
There was a problem hiding this comment.
Do we have an example doc PR generated by this workflow?
Comment on lines
+38
to
+51
| 你是一个技术文档编写专家。请根据以下 GitHub PR 的信息和代码变更 (Diff)， | ||
| 编写一份 Markdown 格式的功能更新文档。 | ||
|
|
||
| PR 标题: {pr.title} | ||
| PR 描述: {pr.body} | ||
|
|
||
| 代码变更: | ||
| {diff} | ||
|
|
||
| 要求: | ||
| 1. 这是一个 {TARGET_DOC_REPO_NAME} 的文档更新。 | ||
| 2. 如果是新功能，解释其用途和用法。 | ||
| 3. 如果是配置项变更，列出新的参数名。 | ||
| 4. 输出内容不包含 ```markdown 这样的包裹符号，直接输出正文。 |
Collaborator
There was a problem hiding this comment.
Will this generate docs in Chinese? Let's use English prompt and English code comments in this PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.
What's changed and what's your intention?
Checklist
Documentation
Release note