Skip to content

fix: update stale util/ references - #307

Open
avp9-nexus wants to merge 1 commit into
coreruleset:mainfrom
avp9-nexus:docs/fix-dead-references
Open

avp9-nexus wants to merge 1 commit into
coreruleset:mainfrom
avp9-nexus:docs/fix-dead-references

Conversation

@avp9-nexus

Copy link
Copy Markdown

what

Two pages send readers to util/ paths that are not in the CRS repository. This applies to them the fixes that coreruleset/coreruleset#4888 makes to INSTALL.md and KNOWN_BUGS.md in that repository.

why

CodeRabbit noted on coreruleset/coreruleset#4888 that this repository carries the same two stale references (coreruleset/coreruleset#4888 (comment)), and I said there that I would open a separate pull request. The link check here does not catch them: they are paths in the text, not links.

The new sentence links to the files shipped with 3.0.0 rather than to the table on the rule ID page (content/3-about-rules/ruleid.md): that page presents it as the mapping to 3.0.0-rc1 IDs, and it differs from the file shipped with 3.0.0 (for example, 981044 maps to 912000 there and to 912120 in 3.0.0).

content/3-about-rules/creating.md (lines 268-269), on a page marked as possibly outdated, also tells rule authors to include their sources "within this util directory"; it names no path, so it is left as is here.

#222 also rewrites the known issues page and keeps this entry, with new wording that no longer names util/join-multiline-rules. If you would rather settle that entry there, I will take the known issues change out of this pull request.

Checked offline against main (ee326b0):

  • the site builds with Hugo 0.164.0 extended, as in test.yml, with the same warnings as main, and english_test.sh passes;
  • apart from the cache-busting timestamps and image IDs that change on every build, only these two pages change in the built site, plus the print page and the search index;
  • a script that checks every util/ path and every coreruleset/coreruleset blob or tree link in content/ against the repository tree (at main, or at v3.0.0 for links to that tag) reports the three paths above on main and nothing on this branch.

refs

ai disclosure

tools used: Claude Code (Claude Opus 5.5)

assisted with: checking the two references CodeRabbit flagged and searching content/ for others, the two edits, the checks above, and the text of this description

review performed: Claude Code ran the checks above in an offline sandbox and reverted each edit on its own to confirm that the path check fails without it; I reviewed the diff and this description before opening the pull request.

The CRS 2.x to 3 upgrade section of the installation guide named util/id_renumbering/update.py and util/id_renumbering/IdNumbering.csv, and the known issues page recommended the util/join-multiline-rules script; none of these paths is in the CRS repository.

The installation guide now names both files as shipped with CRS 3.0.0 and links tree/v3.0.0/id_renumbering, with the sentence that coreruleset/coreruleset#4888 puts in INSTALL.md. The "Apache 2.4 prior to 2.4.11" section of the known issues page is removed, as coreruleset/coreruleset#4888 does with the same entry in KNOWN_BUGS.md: the script was removed in coreruleset/coreruleset#3877, and the platforms the entry names are end of life.
@coderabbitai

coderabbitai Bot commented Oct 24, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Central YAML (base), Organization UI (inherited)
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c25a03e1-5d45-4408-8efe-6e4c566c53c0
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

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.

1 participant