README.md rewritten sentence by sentence (closes #189)

README.md is rewritten from scratch so that every sentence reads on the first pass, and is cut from about 5,600 words to about 3,500. It leads with what netwatch is, what it is for and how to run it, then the page, reporting and deployment, then every setting in a reference section, with design and development last. Mechanism detail the code and its comments already hold is left out; the PR lists each topic dropped and why. TODO.md records the rewrite of the three documents. Model: fable-5-1 (rewrite, review); opus-5-5 (merge) Co-authored-by: clawbot <clawbot@noreply.example.org>
2026-10-26 08:12:59 +01:00
parent 8ce69b7b40
commit 0d08a75793
2 changed files with 390 additions and 553 deletions
@@ -23,6 +23,10 @@ Run `make frontend-viewport-test` in CI as its own step; it is not part of

 # Completed Steps

+- 2026-10-26: `README.md`, `TODO.md` and `test/viewport/README.md` are rewritten
+  sentence by sentence ([#189](https://git.eeqj.de/sneak/netwatch/issues/189)).
+  Each sentence reads on the first pass: one idea, under about 30 words, the
+  verb early. Every statement matches the code on `next`.
 - 2026-10-26: a target whose home page answers with a redirect is checked at
  `/robots.txt` on the same host, which answers without one
  ([#194](https://git.eeqj.de/sneak/netwatch/issues/194)). These are the AWS