feat: add bugbot callout rules #1207
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
content/concepts/users.mdx
Outdated
| caution. | ||
| </> | ||
| } | ||
| /> |
There was a problem hiding this comment.
Bug: Destructive Warning Mismatch: Use Alert Type (Bugbot Rules)
This Callout uses type="info" but describes a destructive operation with unrecoverable data loss. According to the BUGBOT.md rules being added in this same commit, when a Callout warns about deleting data that cannot be recovered, it should use type="alert" instead. The text "If you delete a user, their data will be unrecoverable" contains the indicator word "unrecoverable" (equivalent to "cannot recover") and describes permanent data deletion, which matches the definition and examples for type="alert" in the BUGBOT.md rules (lines 54-71).
content/concepts/users.mdx
Outdated
| accounts or tenants. | ||
| </> | ||
| } | ||
| /> |
There was a problem hiding this comment.
Bug: Enterprise Callouts should use standard type instead of emoji (Bugbot Rules)
Callout should use standard type: This Callout uses a custom emoji="⭐" prop and describes "a cool new enterprise feature". According to the BUGBOT.md rules (Enterprise type definition and Rule 2), when content is about enterprise features or enterprise-specific functionality, it should use type="enterprise" instead of a freeform callout with custom emoji.
scoti-knock
left a comment
scoti-knock
left a comment
There was a problem hiding this comment.
great idea — thank you for doing this!
|
|
||
| **Indicators:** | ||
|
|
||
| - Words like: "tip", "learn more", "you can also", "additionally", "might want to", "could" |
There was a problem hiding this comment.
Bug: Ambiguity from "could" in Info and Warning indicators
The word "could" is listed as an Info indicator, but it also appears in Warning indicators as part of "could result in" (line 39). This creates ambiguity since "could" can indicate both helpful possibilities (Info: "you could also...") and potential problems (Warning: "this could cause..."). The presence of "could" in the Info indicators list without context could lead to misclassification of warning content as info when "could" appears in phrases like "could cause errors" or "could break". The indicator should be more specific (e.g., "you could also" or "could enhance") to avoid this ambiguity.
Description
** Describe what, why and how of the changes clearly and concisely. Add any additional useful context or info, as necessary. **
Todos
** List any todo items necessary before merging, if any. Delete if none. **
Tasks
** Link to task(s) which this PR corresponds to. Example: KNO-54 **
Screenshots
** Attach any screenshots or recordings to visually illustrate the changes, as necessary. Delete if not relevant. **
Note
Introduces BUGBOT rules to validate Callout types in MDX docs, with definitions, validation checks, examples, and review guidance.
/.cursor/rules/BUGBOT.mdto validateCalloutusage in docscontent/**/*.mdx,alwaysApply: trueinfo,warning,alert,enterprise,beta,roadmapemoji/bgColorvs standardtypeWritten by Cursor Bugbot for commit 173d4cf. This will update automatically on new commits. Configure here.