Skip to content

docs: allow H1 headings in .cursorrules#106

Merged
comfyui-wiki merged 1 commit into
Comfy-Org:mainfrom
lin-bot23:fix/cursorrules-allow-h1
Jul 19, 2026
Merged

docs: allow H1 headings in .cursorrules#106
comfyui-wiki merged 1 commit into
Comfy-Org:mainfrom
lin-bot23:fix/cursorrules-allow-h1

Conversation

@lin-bot23

Copy link
Copy Markdown
Contributor

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 frontend display_name translations. 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

  • Single-file change
  • No impact on generated docs
  • Aligns rules with actual pipeline behavior

@coderabbitai

coderabbitai Bot commented Jul 12, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@lin-bot23, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 56 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 9b263c51-eb02-4a51-94c2-fbc534f64f18

📥 Commits

Reviewing files that changed from the base of the PR and between 79e0263 and e732c89.

📒 Files selected for processing (1)
  • .cursorrules
📝 Walkthrough

Walkthrough

The .cursorrules documentation guidance removes the prohibition on level-one headings while retaining the remaining structure and formatting requirements.

Changes

Documentation Rules

Layer / File(s) Summary
Heading rule update
.cursorrules
Removes the rule forbidding level-one headings from the required documentation structure. The remaining documentation requirements are unchanged.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.
@lin-bot23
lin-bot23 force-pushed the fix/cursorrules-allow-h1 branch from 79e0263 to e732c89 Compare July 12, 2026 11:37
@comfyui-wiki
comfyui-wiki merged commit bb7a966 into Comfy-Org:main Jul 19, 2026
4 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 19, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants