docs: allow H1 headings in .cursorrules#106
Conversation
|
Warning Review limit reached
Next review available in: 56 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe ChangesDocumentation Rules
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
The doc_automation pipeline generates node titles as H1 (# Title) by design. This is intentional — the pipeline prepends display_name as H1 from frontend translations. Removing this rule so coderabbitai stops flagging valid H1 headings.
79e0263 to
e732c89
Compare
Summary
Remove the 'Do not use level-one headings' rule from .cursorrules.
Reason
The doc_automation pipeline generates node documentation with H1 titles (
# Display Name) by design — the title is prepended from frontenddisplay_nametranslations. This caused coderabbitai to flag 73+ false-positive comments in PR reviews.All existing docs already use H1; this rule was inconsistent with actual practice.
Files
.cursorrules— removed line 32:6. **Do not use level-one headings**Checklist