Skip to content

docs: update override hygiene rule ranges - #1368

Open
prx-my wants to merge 3 commits into
OWASP:mainfrom
prx-my:docs/fix-override-rule-ranges
Open

prx-my wants to merge 3 commits into
OWASP:mainfrom
prx-my:docs/fix-override-rule-ranges

Conversation

@prx-my

@prx-my prx-my commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

What changed and why

The override-hygiene docs still described the older rule set. The scanner ships 11 OA rules plus 2 PD rules (verified against src/cli/help.ts), but several pages referenced OA001-OA008, OA001-OA009, or "eleven" rules.

This updates:

  • website/docs/cli-reference.md (--check-overrides description and the rule-reference link)
  • website/docs/index.md
  • website/docs/press.md

All now reference OA001-OA011, PD001-PD002 / 13 rules.

Closes #1373

@prx-my
prx-my requested a review from sonukapoor as a code owner October 21, 2026 19:26
Copilot AI balanced review requested due to automatic review settings October 21, 2026 19:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@sonukapoor sonukapoor left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two of the three changes here are right and I checked them against the code rather than the docs: there are thirteen rules on main, OA001 through OA011 plus PD001 and PD002, the hygiene guide already documents all thirteen, and they all run under that flag. So the CLI reference and the index pointer were both stale and your replacements are accurate.

The press page change is the one I need you to drop. That paragraph is our summary of someone else's published review, not a description of the current product, so the number in it is a fact about what Suphi covered in August rather than a figure to keep current. OA011 did not ship until the end of September, so the review cannot have covered thirteen rules and saying it did would misstate what he wrote.

Everything else is good to go. Drop that one line and I will take it.

Comment thread website/docs/press.md Outdated
@prx-my
prx-my force-pushed the docs/fix-override-rule-ranges branch from b4c3d80 to 6931ca9 Compare October 22, 2026 08:59
@prx-my

prx-my commented Oct 22, 2026

Copy link
Copy Markdown
Contributor Author

Removed the press.md change as requested. The PR now only updates cli-reference.md and index.md. You're right that the review summary is a historical record, not a current rule count.

@sonukapoor sonukapoor left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is it, thanks. I checked the rule identifiers against the code rather than against the hygiene guide, since the guide could have been stale in the same direction: there are thirteen on main, OA001 through OA011 plus PD001 and PD002, and they all run under that flag. So both of your replacements are accurate and those two pages now agree with what ships.

Dropping the press page change was the right call. Approved.

This branch has not been deployed

No deployments
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.

[Docs] Override hygiene rule ranges and count are outdated

3 participants