docs: align built-in rules docs with the actual code#2728
Merged
Conversation
|
Contributor
Coverage Report
File CoverageNo changed files found. |
Contributor
|
JLekawa
approved these changes
Apr 8, 2026
…C rule pages Made-with: Cursor
34dce25 to
7b786e8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What/Why/How?
What: Updates
docs/@v2built-in rules documentation for consistency with the CLI rule IDs and codebase.Why: Arazzo rules were documented with incorrect config keys (
sourceDescriptions-*vssourceDescription-*). Open-RPC rules lacked dedicated pages;path-http-verbs-orderwas missing from the index; minor typos and spec ruleset duplication were fixed.How:
sourceDescription-name-uniqueandsourceDescription-type.path-http-verbs-order.mdand linked it from built-in rules and the sidebar.spec-no-duplicated-method-paramsandspec-no-required-params-after-optional, with sidebar and built-in-rules links.built-in-rules.md, added an Overlay subsection, removed duplicatespec-no-invalid-tag-parentsfromspec-ruleset.md, updated cross-links inrecommended.mdandv2.sidebars.yaml.Reference
Internal docs consistency review (built-in rules vs
packages/core).Testing
Screenshots (optional)
N/A
Check yourself
Security
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-*tosourceDescription-*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 forspec-no-duplicated-method-paramsandspec-no-required-params-after-optional, wired into the index and sidebar. Also fixes a few minor typos/duplicates in rule listings (for example inbuilt-in-rules.mdandspec-ruleset.md).Reviewed by Cursor Bugbot for commit 7b786e8. Bugbot is set up for automated code reviews on this repo. Configure here.