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

Merged
clawbot merged 9 commits from readme-rewrite-189 into next 2026-10-26 08:13:00 +01:00
9 Commits
Author SHA1 Message Date
clawbot 17790d12b9 README.md: rework against the seventh review
check / check (push) Waiting to run
Say plainly that an interval change clears the history and the cleared samples still get reported. Model: fable-5-1
2026-10-26 06:58:28 +00:00
clawbot 1f1a5a6234 README.md: rework against the sixth review
check / check (push) Canceled after 0s
Reporting: say that the samples an interval change clears wait apart.

Model: fable-5-1
2026-10-26 06:40:52 +00:00
clawbot df400831da README.md: rework against the fifth review, mostly by cutting
check / check (push) Canceled after 0s
Fixes the seven findings and drops mechanism detail the code
and its comments hold. 5,864 words to 3,500.

Model: fable-5-1
2026-10-26 06:25:11 +00:00
clawbot 28317f428f README.md: rework against the fourth review
check / check (push) Canceled after 0s
CORS: the built page needs no entry. DEBUG: every value is accepted.
Model: fable-5-1
2026-10-26 05:43:31 +00:00
clawbot 49fdca1c96 README.md: rework against the third review
The symbolic link rule, the console line, fx and the Makefile name
are fixed as the review asked. The full pass fixed nine more
sentences: a split subject, a late verb or a claim broader than the
code.

Model: fable-5-1
2026-10-26 05:41:11 +00:00
clawbot ddd3a83fdf README.md: rework against the second review
The four findings: only a recorded failed check is logged, and the
discarded round, given-up checks and the recovery probe log nothing;
prepare-data-dir gives directories, regular files and symbolic links to
the netwatch user, and a hard link keeps its owner and is logged; the
cli entry names what it runs in three short sentences; the 80% timeout
and the early-round rule have their reasons back, so rounds never
overlap.

The full pass also fixed claims broader than the code (a row always
shows its stats; a report is posted every 60 seconds; a file is written
every minute; each refusal answers JSON; every answer to a report
carries rate-limit headers; every setting applies in the image, where
BIND_ADDRESS has no effect; fmt formats all files), six sentences whose
subject was split from its verb (the recovery probe, the forwarded
entry with a port, the failed write's retry and its file, both rate
limits, the nvm archive), and the viewport test's "same ... as"
comparison.

Model: fable-5-1
2026-10-26 05:41:11 +00:00
clawbot 5788ea43e3 README.md: rework against the review findings
The check sentence names HEAD for the S3 regions up front. The rate-limit
sentence states the safe rate plainly: an address that sends at most half
the limit in any 60 seconds is never refused. The upaas `TRUSTED_PROXIES`
entry again warns that a client connecting from a trusted address can
write its own `X-Forwarded-For`, that a connection through a published
Docker port can arrive from the Docker network's gateway, which the
default includes, and that set and empty, every client behind the proxy
shares one allowance. `TODO.md` gets the Completed Steps entry for
#189, now that
#196 has merged. For
#195.

Model: fable-5-1
2026-10-26 05:41:11 +00:00
clawbot 09cc003a01 README.md: name the rounds in which the rows are sorted
Model: fable-5-1
2026-10-26 05:41:11 +00:00
clawbot 2513303b3c README.md rewritten sentence by sentence for a newcomer
Every sentence is under about 30 words, with one idea each. The page,
its targets and what a figure measures come first, then reporting,
deployment, the settings reference, the design, and development last.
No tables; every identifier in backticks. The code on next decides
what is true.

Model: fable-5-1
2026-10-26 05:41:11 +00:00