mirror of
https://github.com/coder/coder.git
synced 2026-06-03 04:58:23 +00:00
DevCats
a5bc0eb37d
This pull request updates the documentation review workflow in `.github/workflows/doc-check.yaml` to improve clarity and introduce sticky comment logic for doc-check reviews. The changes focus on refining the review context messages and providing detailed instructions for updating existing doc-check comments, ensuring more consistent and actionable documentation feedback. **Workflow message and prompt improvements:** * Refined the context messages for different PR trigger types to be clearer and less repetitive, making instructions more concise for the agent. **Sticky comment logic and instructions:** * Updated the task prompt to instruct the agent to look for an existing doc-check comment containing `<!-- doc-check-sticky -->` and update it instead of creating a new one, supporting more efficient and organized review threads. * Added detailed instructions for how to update sticky comments, including checking off addressed items, striking through items no longer needed, adding new items, and warning if changes can't be verified. * Modified the comment format example to include sticky comment conventions, such as strikethrough for reverted items, checkboxes for addressed items, and warnings for unverifiable documentation changes. * Ensured the `<!-- doc-check-sticky -->` marker is placed at the end of the comment for easier identification and updates in future runs.