Skip to content

docs: add rule files content description#269

Merged
fzipi merged 2 commits intomainfrom
feat/add-file-description
Feb 6, 2026
Merged

docs: add rule files content description#269
fzipi merged 2 commits intomainfrom
feat/add-file-description

Conversation

@fzipi
Copy link
Member

@fzipi fzipi commented Feb 6, 2026

what

  • remove TODO from file descriptions
  • complete with the content of each file
  • add v4 also

why

  • provide people with descriptions on what to expect from each file

Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 6, 2026

Deploying crs-documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 376f063
Status: ✅  Deploy successful!
Preview URL: https://8d5d1d8b.documentation-km5.pages.dev
Branch Preview URL: https://feat-add-file-description.documentation-km5.pages.dev

View logs

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the documentation data/source used to describe CRS rule files, replacing placeholder TODOs with actual descriptions and adding coverage for CRS v4 so readers know what to expect in each rules file.

Changes:

  • Filled in missing rule file descriptions (replacing TODOs) in data/filesdescription.yaml.
  • Added a v4 section to the “What’s In The Rules” page to render the new v4 descriptions alongside v3.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
data/filesdescription.yaml Expands the rules-file description dataset, including new v4 entries.
content/3-about-rules/rules.md Adds a v4 “describe-rules” section above the existing v3 section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@fzipi fzipi merged commit 315196c into main Feb 6, 2026
2 checks passed
@fzipi fzipi deleted the feat/add-file-description branch February 6, 2026 22: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.

1 participant