README lacks the Getting Started, Rationale, Design and TODO sections that REPO_POLICIES.md requires #173

New Issue

2026-10-01T20:09:49+02:00

clawbot commented

2026-10-01 20:09:49 +02:00

REPO_POLICIES.md requires these README sections: Description, Getting Started, Entrypoints, Rationale, Design, TODO, License, Author. On next, README.md has Description, Entrypoints, License and Author, but no Getting Started, Rationale, Design or TODO section. Found while bringing TODO.md up to date (#171), whose old Next Step was this.

Definition of done

Getting Started: one copy-pasteable block that builds and runs dnswatcher with a minimal real configuration, using Docker as the README's Docker section does. Checked by running it.
Rationale: why dnswatcher exists, in a few sentences, drawn from what the README already says it does; no new claims.
Design: how the program is structured. The existing Architecture section is that content: retitle or move it rather than duplicate it, keeping Design Principles under it.
TODO: says where the open work lives (TODO.md and the 1.0 milestone, https://git.eeqj.de/sneak/dnswatcher/milestone/7) rather than copying the list.
Section order follows REPO_POLICIES.md. Every sentence is true of the tree. Docs-only.

Sequencing: after #104 and #105 change the README. It edits the same file as the README accuracy sweep #108, so the two run one after the other, never at once.

Model: opus-5-5

`REPO_POLICIES.md` requires these README sections: Description, Getting Started, Entrypoints, Rationale, Design, TODO, License, Author. On `next`, `README.md` has Description, Entrypoints, License and Author, but no Getting Started, Rationale, Design or TODO section. Found while bringing `TODO.md` up to date (https://git.eeqj.de/sneak/dnswatcher/pulls/171), whose old Next Step was this. ## Definition of done - Getting Started: one copy-pasteable block that builds and runs dnswatcher with a minimal real configuration, using Docker as the README's Docker section does. Checked by running it. - Rationale: why dnswatcher exists, in a few sentences, drawn from what the README already says it does; no new claims. - Design: how the program is structured. The existing Architecture section is that content: retitle or move it rather than duplicate it, keeping Design Principles under it. - TODO: says where the open work lives (`TODO.md` and the 1.0 milestone, https://git.eeqj.de/sneak/dnswatcher/milestone/7) rather than copying the list. - Section order follows `REPO_POLICIES.md`. Every sentence is true of the tree. Docs-only. Sequencing: after https://git.eeqj.de/sneak/dnswatcher/issues/104 and https://git.eeqj.de/sneak/dnswatcher/issues/105 change the README. It edits the same file as the README accuracy sweep https://git.eeqj.de/sneak/dnswatcher/issues/108, so the two run one after the other, never at once. Model: opus-5-5

clawbot added this to the 1.0 milestone 2026-10-01 20:09:49 +02:00

clawbot referenced this issue

2026-10-01 20:15:27 +02:00

docs: bring TODO.md up to date (closes #146) #171

clawbot referenced this issue from a commit

2026-10-01 20:30:21 +02:00

docs: bring TODO.md up to date (closes #146)

clawbot referenced this issue

2026-10-01 20:30:33 +02:00

docs: bring TODO.md up to date (closes #146) #171

clawbot referenced this issue

2026-10-01 20:30:33 +02:00

docs: bring TODO.md up to date (closes #146) #171

clawbot referenced this issue

2026-10-01 20:50:05 +02:00

docs: bring TODO.md up to date (closes #146) #171

clawbot referenced this issue from a commit

2026-10-01 21:21:49 +02:00

docs: bring TODO.md up to date (closes #146)

clawbot referenced this issue from a commit

2026-10-01 21:32:51 +02:00

docs: bring TODO.md up to date (closes #146)

clawbot referenced this issue from a commit

2026-10-02 00:24:47 +02:00

docs: add the README sections policy requires (closes #173)

clawbot referenced a pull request that will close this issue

2026-10-02 00:26:39 +02:00

docs: add the README sections policy requires (closes #173) #198

clawbot commented

2026-10-02 00:26:49 +02:00

#198 adds Getting Started, Rationale and TODO to the README and turns Architecture into Design, moved below Entrypoints with its text unchanged, so the required sections come in policy order. The missing files in the Design tree are left for #108.

Model: opus-5-5

https://git.eeqj.de/sneak/dnswatcher/pulls/198 adds Getting Started, Rationale and TODO to the README and turns Architecture into Design, moved below Entrypoints with its text unchanged, so the required sections come in policy order. The missing files in the Design tree are left for https://git.eeqj.de/sneak/dnswatcher/issues/108. Model: opus-5-5

clawbot referenced this issue

2026-10-02 00:46:32 +02:00

docs: add the README sections policy requires (closes #173) #198

clawbot referenced this issue from a commit

2026-10-02 01:04:59 +02:00

docs: add the README sections policy requires (closes #173)

clawbot referenced this issue from a commit

2026-10-02 01:24:33 +02:00

docs: add the README sections policy requires (closes #173)

clawbot closed this issue

2026-10-02 01:25:14 +02:00

clawbot referenced this issue from a commit