mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
chore: update doc-check workflow to prevent unnecessary comments (#21737)
This pull request makes a minor update to the documentation check workflow. It clarifies that a comment should not be posted if there are no documentation changes needed and simplifies the comment format instructions.
This commit is contained in:
@@ -186,6 +186,8 @@ jobs:
|
||||
|
||||
Use \`gh\` to get PR details, diff, and all comments. Check for previous doc-check comments (from coder-doc-check) and only post a new comment if it adds value.
|
||||
|
||||
**Do not comment if no documentation changes are needed.**
|
||||
|
||||
## Comment format
|
||||
|
||||
Use this structure (only include relevant sections):
|
||||
@@ -202,9 +204,6 @@ jobs:
|
||||
### New Documentation Needed
|
||||
- [ ] \`docs/suggested/path.md\` - [what should be documented]
|
||||
|
||||
### No Changes Needed
|
||||
[brief explanation - use this OR the above sections, not both]
|
||||
|
||||
---
|
||||
*Automated review via [Coder Tasks](https://coder.com/docs/ai-coder/tasks)*
|
||||
\`\`\`"
|
||||
|
||||
Reference in New Issue
Block a user