sneak/smallwebwaf
1
0
Fork 0
Code Issues 5 Pull Requests 2 Actions 6 Packages Projects Releases Wiki Activity

Rewrite README.md from scratch so a newcomer can follow it #155

New Issue
Open
opened 2026-10-22 20:00:34 +02:00 by clawbot · 1 comment
clawbot commented 2026-10-22 20:00:34 +02:00
Collaborator
Copy Link
Copy Source

sneak, 22 October (chat): "the smallwebwaf readme is incomprehensible. it NEVER should have landed in its current form. use this primary account right now to have fable make a PR rewriting it from scratch using the original as reference. in places where the readme is unclear, refer to the code or spec document."

What. Rewrite README.md from scratch. The current README is the reference for what to cover, not a text to edit. Where it is unclear, the code and the spec document decide what is true.

Definition of done.

  • A competent newcomer who has never seen smallwebwaf can read the new README once and know what it is, what it protects against, how to run it in front of a site, how to configure it, and how to check that it works.
  • Every statement matches the code on next; nothing describes behaviour that is not built.
  • Plain words, no coined terms; every identifier, flag, variable and file name in backticks; no markdown tables.
  • make fmt applied and script/cibuild green on the branch.
  • One PR into next, its title ending with (closes #N), N being this issue.

Model: opus-5-5

sneak, 22 October (chat): "the smallwebwaf readme is incomprehensible. it NEVER should have landed in its current form. use this primary account right now to have fable make a PR rewriting it from scratch using the original as reference. in places where the readme is unclear, refer to the code or spec document." **What.** Rewrite `README.md` from scratch. The current README is the reference for what to cover, not a text to edit. Where it is unclear, the code and the spec document decide what is true. **Definition of done.** - A competent newcomer who has never seen smallwebwaf can read the new README once and know what it is, what it protects against, how to run it in front of a site, how to configure it, and how to check that it works. - Every statement matches the code on `next`; nothing describes behaviour that is not built. - Plain words, no coined terms; every identifier, flag, variable and file name in backticks; no markdown tables. - `make fmt` applied and `script/cibuild` green on the branch. - One PR into `next`, its title ending with (closes #N), N being this issue. Model: opus-5-5
clawbot commented 2026-10-22 20:38:11 +02:00
Author
Collaborator
Copy Link
Copy Source

The rewrite is up for review as #157, into next, make fmt applied and script/cibuild green.

Model: fable-5-1

The rewrite is up for review as https://git.eeqj.de/sneak/smallwebwaf/pulls/157, into `next`, `make fmt` applied and `script/cibuild` green. Model: fable-5-1
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
critical
Extremely important: data loss, a security hole, production down, or basic use impossible
 merge-ready
Reviewed and ready for the owner to merge
 needs-checks
Checks must be fixed before review
 needs-rebase
Conflicts with next; rebase required
 needs-review
Review not yet done
 needs-rework
Review found issues to fix
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
clawbot sneak (Jeffrey Paul)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/smallwebwaf#155