README: rewrite on Fable into sections, with compose examples and an env var table #188

New Issue

2026-11-05T20:47:19+01:00

clawbot commented

2026-11-05 20:47:19 +01:00

sneak, 2026-11-05 in chat: "have fable rewrite the smallwebwaf readme to make it less spaghetti. it mixes documentation and architecture, and is very repetitive. organize it into sections. give some examples of what it would look like in a docker-compose. use examples that demonstrate different configurations. document all of the env vars in a table and show their defaults."

Written on Fable, as he asked. The table is his order and overrides the no-tables rule for this README.

Definition of done:

README.md is organized into sections. What an operator needs (what it does, how to run it, configuration, examples) comes first; how it works inside is one separate section, not mixed into the rest.
Each fact is stated once. Nothing is repeated across sections.
Several docker-compose.yml examples, each showing a different configuration, for example: the smallest working setup in front of one app; custom limits; in front of Gitea with limits that allow API use. Every example uses only settings the code on next has, and each one passes docker compose config.
Every environment variable the code on next reads is in one table with its default and what it does, read from the code, not from older documents. None is missing, and none is listed that the code does not read.
The prose follows the repo's documentation rules (AGENTS.md).
One commit ending (closes #N), PR into next; make fmt applied and make check passes.

Model: opus-5-5

sneak, 2026-11-05 in chat: "have fable rewrite the smallwebwaf readme to make it less spaghetti. it mixes documentation and architecture, and is very repetitive. organize it into sections. give some examples of what it would look like in a docker-compose. use examples that demonstrate different configurations. document all of the env vars in a table and show their defaults." Written on Fable, as he asked. The table is his order and overrides the no-tables rule for this README. Definition of done: - `README.md` is organized into sections. What an operator needs (what it does, how to run it, configuration, examples) comes first; how it works inside is one separate section, not mixed into the rest. - Each fact is stated once. Nothing is repeated across sections. - Several `docker-compose.yml` examples, each showing a different configuration, for example: the smallest working setup in front of one app; custom limits; in front of Gitea with limits that allow API use. Every example uses only settings the code on `next` has, and each one passes `docker compose config`. - Every environment variable the code on `next` reads is in one table with its default and what it does, read from the code, not from older documents. None is missing, and none is listed that the code does not read. - The prose follows the repo's documentation rules (`AGENTS.md`). - One commit ending `(closes #N)`, PR into `next`; `make fmt` applied and `make check` passes. Model: opus-5-5

clawbot referenced this issue from a commit

2026-11-05 20:58:07 +01:00

README: sections, compose examples, env var table (closes #188)

clawbot referenced a pull request that will close this issue

2026-11-05 20:58:14 +01:00

README: sections, compose examples, env var table (closes #188) #189

clawbot referenced this issue from a commit

2026-11-05 21:18:42 +01:00

README: sections, compose examples, env var table (closes #188)

clawbot closed this issue

2026-11-06 00:06:25 +01:00

clawbot referenced this issue from a commit