Rewrite README.md and the other prose documents sentence by sentence, on Fable #327

Closed
opened 2026-10-22 20:16:28 +02:00 by clawbot · 5 comments
Collaborator

This repo's README.md is 9459 words on next (22 October).

sneak, 22 October (chat), after smallwebwaf's README turned out to fail sentence by sentence: "just file issues on the repos about it, and specify that it has to be fable, and make the issues detailed - include your rules. we're not doing this work today (except on smallwebwaf)". What went wrong there, and the rules below, are on sneak/project-management#39 (comment).

Not today. This waits until the fleet restarts (25 October at the earliest) and the repo's manager has room. It is not urgent, but it comes before this repo's next release-candidate tag.

Who. This must be done by Fable: a genius-bar session (--agent genius-bar --model fable --effort xhigh, on a worker account) that wrote none of the documents. Opus workers do not do this unit.

What.

  1. Read README.md and every other prose document in the repo, such as SPEC.md, DESIGN.md and prose under docs/, sentence by sentence, as a newcomer would. Check each sentence against the rules below.
  2. Rewrite each document that fails from scratch. The old text is only the reference for what a reader needs covered; do not edit it in place. Where the old text is unclear or disagrees with the code on next, the code decides what is true and the spec explains the intent. List any disagreement in the PR body; do not settle it silently.
  3. A document that passes is left alone; say so on this issue.
  4. Leave out anything the code does not do, and describe nothing that is not built.

The rules, sentence by sentence. A sentence fails when a newcomer cannot parse it on first reading. It always fails when it:

  • runs past about 30 words, or chains a list of things with commas where a bulleted list belongs;
  • stacks clauses so the verb or the subject arrives late, for example "refuses a client a blocklist you name lists";
  • paraphrases where a plain common name exists, for example "the bans that broken rate limits lead to" instead of rate-limit bans;
  • narrates the project's own history or plan (milestones, stages, build order, issue links) in a document meant for users;
  • puts an exception or rare edge case before the main rule, or anywhere in the opening.

Also:

  • one idea per sentence; subject and verb early;
  • a false statement fails too, but an inaccurate sentence is fixed by writing a correct short sentence, never by adding qualifiers;
  • the README leads with what the program is, what it is for and how to use it; every setting goes in a reference section after that; development and testing come last;
  • plain words, no coined terms, no jargon a newcomer would not know, and any technical word defined on first use;
  • every identifier, flag, environment variable, path, command and file name in backticks; no markdown tables; no superlatives or praise;
  • read every sentence once more before committing, and rewrite any you would have to read twice.

Definition of done.

  • Every prose document in the repo passes the rules above, read sentence by sentence.
  • Every statement matches the code on next.
  • One PR into next for each rewritten document. The last of them ends its title with (closes #N), N being this issue.
  • Each PR passes an independent pr-reviewer applying agents/pr-reviewer.md step 4 to every sentence, before it is squash-merged.
  • make fmt applied, and script/cibuild green on a fresh clone.

Model: opus-5-5

This repo's `README.md` is 9459 words on `next` (22 October). sneak, 22 October (chat), after smallwebwaf's README turned out to fail sentence by sentence: "just file issues on the repos about it, and specify that it has to be fable, and make the issues detailed - include your rules. we're not doing this work today (except on smallwebwaf)". What went wrong there, and the rules below, are on https://git.eeqj.de/sneak/project-management/issues/39#issuecomment-154280. **Not today.** This waits until the fleet restarts (25 October at the earliest) and the repo's manager has room. It is not urgent, but it comes before this repo's next release-candidate tag. **Who.** This must be done by Fable: a genius-bar session (`--agent genius-bar --model fable --effort xhigh`, on a worker account) that wrote none of the documents. Opus workers do not do this unit. **What.** 1. Read `README.md` and every other prose document in the repo, such as `SPEC.md`, `DESIGN.md` and prose under `docs/`, sentence by sentence, as a newcomer would. Check each sentence against the rules below. 2. Rewrite each document that fails from scratch. The old text is only the reference for what a reader needs covered; do not edit it in place. Where the old text is unclear or disagrees with the code on `next`, the code decides what is true and the spec explains the intent. List any disagreement in the PR body; do not settle it silently. 3. A document that passes is left alone; say so on this issue. 4. Leave out anything the code does not do, and describe nothing that is not built. **The rules, sentence by sentence.** A sentence fails when a newcomer cannot parse it on first reading. It always fails when it: - runs past about 30 words, or chains a list of things with commas where a bulleted list belongs; - stacks clauses so the verb or the subject arrives late, for example "refuses a client a blocklist you name lists"; - paraphrases where a plain common name exists, for example "the bans that broken rate limits lead to" instead of rate-limit bans; - narrates the project's own history or plan (milestones, stages, build order, issue links) in a document meant for users; - puts an exception or rare edge case before the main rule, or anywhere in the opening. Also: - one idea per sentence; subject and verb early; - a false statement fails too, but an inaccurate sentence is fixed by writing a correct short sentence, never by adding qualifiers; - the README leads with what the program is, what it is for and how to use it; every setting goes in a reference section after that; development and testing come last; - plain words, no coined terms, no jargon a newcomer would not know, and any technical word defined on first use; - every identifier, flag, environment variable, path, command and file name in backticks; no markdown tables; no superlatives or praise; - read every sentence once more before committing, and rewrite any you would have to read twice. **Definition of done.** - Every prose document in the repo passes the rules above, read sentence by sentence. - Every statement matches the code on `next`. - One PR into `next` for each rewritten document. The last of them ends its title with (closes #N), N being this issue. - Each PR passes an independent pr-reviewer applying `agents/pr-reviewer.md` step 4 to every sentence, before it is squash-merged. - `make fmt` applied, and `script/cibuild` green on a fresh clone. Model: opus-5-5
Author
Collaborator

Starting now, on Fable, against next at 2c90144. Scope and facts for this run, from the reviews of the units that just landed:

  • README.md is rewritten from scratch, as this issue says. AGENTS.md and TODO.md are read and get one line each here: passes, fails, or out of scope, and why. REPO_POLICIES.md is the canonical copy from sneak/prompts and is not edited.
  • The Configuration section keeps one list item per setting, starting with the key in backticks, as its first list; a test in internal/config reads it against the code's table of settings.
  • The cache_max_bytes default is stated with its 500 MiB floor.
  • An encrypted URL made to last forever holds no expiry.
  • The 499 answer has no body, and is given when the client goes away before its image is ready, unless its request is the one making the image.

Model: opus-5-5

Starting now, on Fable, against `next` at `2c90144`. Scope and facts for this run, from the reviews of the units that just landed: - `README.md` is rewritten from scratch, as this issue says. `AGENTS.md` and `TODO.md` are read and get one line each here: passes, fails, or out of scope, and why. `REPO_POLICIES.md` is the canonical copy from `sneak/prompts` and is not edited. - The Configuration section keeps one list item per setting, starting with the key in backticks, as its first list; a test in `internal/config` reads it against the code's table of settings. - The `cache_max_bytes` default is stated with its 500 MiB floor. - An encrypted URL made to last forever holds no expiry. - The 499 answer has no body, and is given when the client goes away before its image is ready, unless its request is the one making the image. Model: opus-5-5
Author
Collaborator

Read for this run, one line each:

  • AGENTS.md: a prose document for readers (the agents), and it fails: the rule on changing an existing test is one 45-word sentence of stacked clauses; the branch rule says a feature branch merges into main, while TODO.md has work landing on next; and Last Updated 2026-01-08 is stale. Not rewritten in this run.
  • TODO.md: out of scope: it is the agents' working log and plan (workflow, status, completed and future steps), merged by git's union merge and read for its history, which the rules for a reader's document forbid by design.

README.md is rewritten from scratch; the PR follows.

Model: fable-5-1

Read for this run, one line each: - `AGENTS.md`: a prose document for readers (the agents), and it fails: the rule on changing an existing test is one 45-word sentence of stacked clauses; the branch rule says a feature branch merges into `main`, while `TODO.md` has work landing on `next`; and `Last Updated 2026-01-08` is stale. Not rewritten in this run. - `TODO.md`: out of scope: it is the agents' working log and plan (workflow, status, completed and future steps), merged by git's union merge and read for its history, which the rules for a reader's document forbid by design. `README.md` is rewritten from scratch; the PR follows. Model: fable-5-1
Author
Collaborator

PR: #345 (branch issue-327-readme-rewrite, head a90c19a).

Model: fable-5-1

PR: https://git.eeqj.de/sneak/pixa/pulls/345 (branch `issue-327-readme-rewrite`, head `a90c19a`). Model: fable-5-1
Author
Collaborator

The README.md rewrite, #345, failed review three times and is paused for sneak's review. The rest of this issue goes on: AGENTS.md, which the reading above found failing, is rewritten next on Fable as its own PR.

Decided from the record: every rule in AGENTS.md keeps its meaning and its emphasis; only sentences are split and made plain. Three statements that are false against the repo or sneak's standing rulings are corrected: the format check is make fmt-check, not make check-fmt; a feature branch lands on next, and only sneak merges next into main; the naming example uses the code's term, allowlist. The Last Updated line takes the date of the change. That PR does not close this issue while the README.md PR is paused.

Model: opus-5-5

The `README.md` rewrite, https://git.eeqj.de/sneak/pixa/pulls/345, failed review three times and is paused for sneak's review. The rest of this issue goes on: `AGENTS.md`, which the reading above found failing, is rewritten next on Fable as its own PR. Decided from the record: every rule in `AGENTS.md` keeps its meaning and its emphasis; only sentences are split and made plain. Three statements that are false against the repo or sneak's standing rulings are corrected: the format check is `make fmt-check`, not `make check-fmt`; a feature branch lands on `next`, and only sneak merges `next` into `main`; the naming example uses the code's term, allowlist. The `Last Updated` line takes the date of the change. That PR does not close this issue while the `README.md` PR is paused. Model: opus-5-5
Author
Collaborator

AGENTS.md rewrite PR: #346 (branch issue-327-agents-rewrite, head 60a375a). It does not close this issue while #345 is paused.

Model: fable-5-1

`AGENTS.md` rewrite PR: https://git.eeqj.de/sneak/pixa/pulls/346 (branch `issue-327-agents-rewrite`, head `60a375a`). It does not close this issue while https://git.eeqj.de/sneak/pixa/pulls/345 is paused. Model: fable-5-1
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/pixa#327