Skip to content

docs: add tools for rule writers#267

Merged
fzipi merged 4 commits intomainfrom
docs/add-tools-rule-writes
Feb 6, 2026
Merged

docs: add tools for rule writers#267
fzipi merged 4 commits intomainfrom
docs/add-tools-rule-writes

Conversation

@fzipi
Copy link
Member

@fzipi fzipi commented Feb 6, 2026

what

  • add tools for rule writes

why

  • help devs test rules before pushing

refs

Fixes #73.

Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi requested a review from Copilot February 6, 2026 20:14
@fzipi fzipi changed the title docs: add tools for rule writes docs: add tools for rule writers Feb 6, 2026
@fzipi fzipi requested a review from a team February 6, 2026 20:15
@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: e2484e2
Status: ✅  Deploy successful!
Preview URL: https://5f261c59.documentation-km5.pages.dev
Branch Preview URL: https://docs-add-tools-rule-writes.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

Adds a new documentation page to help CRS rule writers discover and use commonly used third-party and CRS-specific tooling, aligning with the goal of making rule development more approachable for new contributors (Fixes #73).

Changes:

  • Adds a “Tools for Rule Writers” page with categorized tool links (regex, DB playgrounds, encoders, HTTP clients, XSS resources).
  • Includes a suggested end-to-end workflow for developing and testing rules with these tools.
  • Links to existing CRS docs for crs-toolchain, go-ftw, and the broader “Useful Tools” page.

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

@fzipi
Copy link
Member Author

fzipi commented Feb 6, 2026

@copilot open a new pull request to apply changes based on the comments in this thread

Copy link
Contributor

Copilot AI commented Feb 6, 2026

@fzipi I've opened a new pull request, #268, to work on those changes. Once the pull request is ready, I'll request review from you.

fzipi and others added 3 commits February 6, 2026 18:44
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
* Initial plan

* docs: add aliases and security warning to tools page

- Add aliases field to front matter for stable URL path
- Update Base64 encoder description with security warning against using real credentials

Co-authored-by: fzipi <3012076+fzipi@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: fzipi <3012076+fzipi@users.noreply.github.com>
Signed-off-by: Felipe Zipitria <felipe.zipitria@owasp.org>
@fzipi fzipi merged commit f6489d6 into main Feb 6, 2026
2 checks passed
@fzipi fzipi deleted the docs/add-tools-rule-writes branch February 6, 2026 22:14
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.

feat(docs): Expose tooling for rule developers

2 participants