README: Getting Started never says which address to open, and three other gaps #210

New Issue

2026-11-11T21:16:30+01:00

clawbot commented

2026-11-11 21:16:30 +01:00

Four places where README.md left a new user guessing or was wrong. Found by the acceptance test on #204.

Getting Started never says which address to open. After make run, http://localhost:8080/ answers 404 page not found: netwatch-server serves no page. The page is at http://localhost:5173/ from make dev, with make run in a second terminal so its reports are stored. From the image, it is at http://localhost:8080/. The line "Build the page and netwatch-server, then run the server on port 8080" invites opening port 8080.
"gray is no answer" (Rows, colors and controls). The figure for a failed check is gray. In the graph, a failed check is a faint red band.
The report's timestamp (Reporting) is described as "the time of the report", with no form given. It is an ISO 8601 string such as 2026-11-11T20:01:35.685Z, unlike the samples' t, which is Unix milliseconds. A report whose timestamp is a number is refused with 400.
The YAML settings file (Settings) is named, but not what goes in it. Its keys are the variable names, such as PORT: 8090, in upper or lower case.

Definition of done

Getting Started says, right after the commands, which address to open for make dev and for the image, and that make run serves no page.
Rows, colors and controls says how the graph shows a failed check.
Reporting says timestamp is an ISO 8601 string.
Settings gives one example line of netwatch-server.yaml.
make fmt run on the change.

Model: opus-5-5

Four places where `README.md` left a new user guessing or was wrong. Found by the acceptance test on https://git.eeqj.de/sneak/netwatch/issues/204. - **Getting Started never says which address to open.** After `make run`, `http://localhost:8080/` answers `404 page not found`: `netwatch-server` serves no page. The page is at `http://localhost:5173/` from `make dev`, with `make run` in a second terminal so its reports are stored. From the image, it is at `http://localhost:8080/`. The line "Build the page and netwatch-server, then run the server on port 8080" invites opening port 8080. - **"gray is no answer"** (Rows, colors and controls). The figure for a failed check is gray. In the graph, a failed check is a faint red band. - **The report's `timestamp`** (Reporting) is described as "the time of the report", with no form given. It is an ISO 8601 string such as `2026-11-11T20:01:35.685Z`, unlike the samples' `t`, which is Unix milliseconds. A report whose `timestamp` is a number is refused with 400. - **The YAML settings file** (Settings) is named, but not what goes in it. Its keys are the variable names, such as `PORT: 8090`, in upper or lower case. ## Definition of done - [ ] Getting Started says, right after the commands, which address to open for `make dev` and for the image, and that `make run` serves no page. - [ ] Rows, colors and controls says how the graph shows a failed check. - [ ] Reporting says `timestamp` is an ISO 8601 string. - [ ] Settings gives one example line of `netwatch-server.yaml`. - [ ] `make fmt` run on the change. Model: opus-5-5

clawbot referenced this issue

2026-11-11 21:17:13 +01:00

Acceptance test: use netwatch end to end as a user before a release candidate #204

clawbot referenced this issue from a commit

2026-11-11 21:27:21 +01:00

README: page address, failed-check band, timestamp form, YAML keys (closes #210)

clawbot referenced a pull request that will close this issue

2026-11-11 21:27:27 +01:00

README: page address, failed-check band, timestamp form, YAML keys (closes #210) #215

clawbot commented

2026-11-11 21:27:45 +01:00