2 Commits
Author SHA1 Message Date
clawbot 50984e8bd0 Rework the README after the second review
check / check (push) Waiting to run
The nine findings: the heap figure keeps the old README's meaning; the
Makefile sentence names the three targets that call no script; the five
fields /api/v1/stats adds are a list; the test comment names README
"JSON API"; the X-Forwarded-For readers are a list, with short sentences
after it; the AS page's peers are the ASes next to it in AS paths; CIDR
ranges and the default route are explained; handle and description are
field names; the TODO entry is one sentence.

The sweep of every sentence defined feed, carry, IANA, multicast,
handler, streamer, reverse proxy and goroutine at first use, split the
list of parts, and named the 404 of an unknown page path.

Model: fable-5-1
2026-11-02 00:46:10 +00:00
sneak 6c0bfc1690 Rewrite the README sentence by sentence
check / check (push) Canceled after 0s
The README is rewritten from scratch against the prose rules of
#157: every sentence under
about 30 words, lists as bullets, every technical term defined where it
first appears, and every statement checked against the code on next. It
leads with what RouteWatch is and how to run it, then the pages, the API
and the blocklists, then the settings, memory and upaas, and last the
design and the development workflow. The dated entry goes into TODO.md.

Model: fable-5-1
2026-11-02 00:03:50 +00:00
3 changed files with 722 additions and 579 deletions
+719 -578
View File
File diff suppressed because it is too large Load Diff
+2
View File
@@ -35,6 +35,8 @@ tested.
# Completed Steps
- 2026-11-02: `README.md` rewritten from scratch, sentence by sentence, and
checked against the code (part of #157)
- 2026-10-27: the tests of `internal/routewatch` no longer fail on a loaded
host. Five of them gave `HandleMessage` two seconds to apply a full prefix
batch, which under the race detector can take longer. A test now waits up to
+1 -1
View File
@@ -261,7 +261,7 @@ func checkAnswerCarriesMeta(
) {
t.Helper()
// The values README "API v1" gives the two fields that never change.
// The values README "JSON API" gives the two fields that never change.
const (
wantTimeZone = "UTC"
wantAPIVersion = 1