Skip to content

docs: align built-in rules docs with the actual code#2728

Merged
tatomyr merged 1 commit intomainfrom
cursor/docs-v2-built-in-rules-updates
Apr 10, 2026
Merged

docs: align built-in rules docs with the actual code#2728
tatomyr merged 1 commit intomainfrom
cursor/docs-v2-built-in-rules-updates

Conversation

@tatomyr
Copy link
Copy Markdown
Collaborator

@tatomyr tatomyr commented Apr 8, 2026

What/Why/How?

What: Updates docs/@v2 built-in rules documentation for consistency with the CLI rule IDs and codebase.

Why: Arazzo rules were documented with incorrect config keys (sourceDescriptions-* vs sourceDescription-*). Open-RPC rules lacked dedicated pages; path-http-verbs-order was missing from the index; minor typos and spec ruleset duplication were fixed.

How:

  • Renamed Arazzo rule doc files and corrected YAML examples to use sourceDescription-name-unique and sourceDescription-type.
  • Added path-http-verbs-order.md and linked it from built-in rules and the sidebar.
  • Added Open-RPC rule pages for spec-no-duplicated-method-params and spec-no-required-params-after-optional, with sidebar and built-in-rules links.
  • Fixed typos in built-in-rules.md, added an Overlay subsection, removed duplicate spec-no-invalid-tag-parents from spec-ruleset.md, updated cross-links in recommended.md and v2.sidebars.yaml.

Reference

Internal docs consistency review (built-in rules vs packages/core).

Testing

  • Documentation-only change; reviewed markdown and sidebar paths locally.

Screenshots (optional)

N/A

Check yourself

  • This PR follows the contributing guide
  • All new/updated code is covered by tests
  • Core code changed? - Tested with other Redocly products (internal contributions only)
  • New package installed? - Tested in different environments (browser/node)
  • Documentation update has been considered

Security

  • The security impact of the change has been considered
  • Code follows company security practices and guidelines

Note

Low Risk
Documentation-only updates that rename rule IDs and add missing rule pages/links; main risk is broken doc links or confusion if any references were missed.

Overview
Aligns v2 rules documentation with the actual CLI rule IDs by correcting Arazzo rule names from sourceDescriptions-* to sourceDescription-* across rule pages and ruleset lists, and updating cross-links accordingly.

Adds missing documentation coverage and navigation for path-http-verbs-order (new rule page plus inclusion in the built-in rules index and sidebar) and introduces dedicated Open-RPC rule pages for spec-no-duplicated-method-params and spec-no-required-params-after-optional, wired into the index and sidebar. Also fixes a few minor typos/duplicates in rule listings (for example in built-in-rules.md and spec-ruleset.md).

Reviewed by Cursor Bugbot for commit 7b786e8. Bugbot is set up for automated code reviews on this repo. Configure here.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 8, 2026

⚠️ No Changeset found

Latest commit: 7b786e8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 79.9% (🎯 79%) 6696 / 8380
🔵 Statements 79.33% (🎯 79%) 6932 / 8738
🔵 Functions 82.96% (🎯 82%) 1359 / 1638
🔵 Branches 71.58% (🎯 71%) 4557 / 6366
File CoverageNo changed files found.
Generated in workflow #9380 for commit 7b786e8 by the Vitest Coverage Report Action

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

CLI Version Mean Time ± Std Dev (s) Relative Performance (Lower is Faster)
cli-latest 3.491s ± 0.033s ▓▓▓ 1.10x
cli-next 3.182s ± 0.017s ▓ 1.00x (Fastest)

@tatomyr tatomyr changed the title docs(@v2): align built-in rules docs with rule IDs and add missing pages docs: align built-in rules docs with the actual code Apr 8, 2026
@tatomyr tatomyr self-assigned this Apr 8, 2026
@tatomyr tatomyr marked this pull request as ready for review April 8, 2026 16:08
@tatomyr tatomyr requested a review from a team as a code owner April 8, 2026 16:08
@tatomyr tatomyr force-pushed the cursor/docs-v2-built-in-rules-updates branch from 34dce25 to 7b786e8 Compare April 10, 2026 06:02
@tatomyr tatomyr merged commit 1076252 into main Apr 10, 2026
47 checks passed
@tatomyr tatomyr deleted the cursor/docs-v2-built-in-rules-updates branch April 10, 2026 06:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants