README has no Rationale section, which REPO_POLICIES requires #121

Closed
opened 2026-10-19 22:35:33 +02:00 by clawbot · 1 comment
Collaborator

Where: README.md (section headings).

REPO_POLICIES.md lists the README's required sections: Description, Getting Started, Entrypoints, Rationale ("Why does this exist?"), Design, TODO, License, Author. The README has Features, Installation, Usage, HTTP Endpoints, Code Structure, Architecture Overview, Configuration, Memory, Running under upaas, Development, Entrypoints, License and Author. Getting Started and Design exist in substance under Installation/Usage and Architecture Overview, and the TODO list lives in TODO.md by this repository's established workflow. Nothing anywhere says why the program exists: the first paragraph states what it does (the Description), not the reason for it.

Severity: low (documentation; no runtime effect).

Definition of done

  • README has a short Rationale section (why a self-hosted live BGP table with IP-to-AS lookups), formatted with make fmt; optionally Installation and Usage are headed Getting Started.
  • Check, failing before the fix: grep -c '^## Rationale' README.md is 0 today and 1 after.
  • make check passes.

Model: fable-5-1

Where: `README.md` (section headings). REPO_POLICIES.md lists the README's required sections: Description, Getting Started, Entrypoints, Rationale ("Why does this exist?"), Design, TODO, License, Author. The README has Features, Installation, Usage, HTTP Endpoints, Code Structure, Architecture Overview, Configuration, Memory, Running under upaas, Development, Entrypoints, License and Author. Getting Started and Design exist in substance under Installation/Usage and Architecture Overview, and the TODO list lives in `TODO.md` by this repository's established workflow. Nothing anywhere says why the program exists: the first paragraph states what it does (the Description), not the reason for it. Severity: low (documentation; no runtime effect). ## Definition of done - README has a short Rationale section (why a self-hosted live BGP table with IP-to-AS lookups), formatted with `make fmt`; optionally Installation and Usage are headed Getting Started. - Check, failing before the fix: `grep -c '^## Rationale' README.md` is 0 today and 1 after. - `make check` passes. Model: fable-5-1
clawbot self-assigned this 2026-10-19 22:35:33 +02:00
Author
Collaborator

The README now has a Rationale section, right after the opening description: #148

Model: opus-5-5

The README now has a Rationale section, right after the opening description: https://git.eeqj.de/sneak/routewatch/pulls/148 Model: opus-5-5
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/routewatch#121