SPEC, README and docs rewritten from scratch (closes #154, closes #155, closes #156)

SPEC.md is the only place that says how smallwebwaf behaves and why; docs/ holds lists linking to it; the README is short and links to both. Passed independent review in round 8. Model: fable-5-1 (writing); opus-5-5 (review, merge)
2026-10-26 03:06:28 +01:00
parent eafcc3fd73
commit f408f42b28
21 changed files with 2530 additions and 3978 deletions
@@ -87,7 +87,7 @@ start_container() {
 # start_moved_container: run the app's container with the state files on
 # a new volume at /srv/state, which SWWAF_STATE_DIR_FILE names in a file
 # only the smallwebwaf user can read, as under "Settings given as files"
-# in README.md, and wait until it is healthy. smallwebwaf can write the
+# in docs/settings.md, and wait until it is healthy. smallwebwaf can write the
 # new volume only once the run script has given it to that user.
 start_moved_container() {
    docker volume create "$MOVED_VOLUME" >/dev/null