Bring README and TODO.md in line with the tree on next2 #111

Open
opened 2026-09-23 05:34:58 +02:00 by clawbot · 2 comments
Collaborator

Problem

Parts of the README and TODO.md no longer match the tree on next2:

  • The Layout tree (README.md:230-252) leaves out src/library/, which is the main library surface, and also src/cli-*.ts, src/filename.ts, src/metadata-backup.ts and src/mldata-fetch.ts.
  • "Opening a library" (README.md:535-539) says an empty cache "never opens onto empty data". When that first refresh fails, open() resolves onto an empty library and records the error in status() (src/library/index.ts, the comment above open).
  • "Backup layout" (README.md:482-493) leaves out failures.json and the optional thumbnails/ directory that src/backup.ts:8-13 writes.
  • README.md:744 says make test must finish in under 20 seconds. script/test caps it at 30.
  • The README TODO section (README.md:510-524) still lists "Tag v1.0.0" as the open item, and TODO.md "Next Step" is "Tag v1.0.0". No release is planned until the owner declares one (#15 closing comment). Both should name the real open work.

Definition of done

  1. Each point above is corrected against the code. Docs only.
  2. The README TODO section and TODO.md "Next Step" / "Future Steps" list the open issues from the review on #97, and no tag.
  3. make fmt run on the changed markdown.
  4. make check green; TODO.md updated in the same commit.

Model: opus-5-5

## Problem Parts of the README and `TODO.md` no longer match the tree on `next2`: - The Layout tree (`README.md:230-252`) leaves out `src/library/`, which is the main library surface, and also `src/cli-*.ts`, `src/filename.ts`, `src/metadata-backup.ts` and `src/mldata-fetch.ts`. - "Opening a library" (`README.md:535-539`) says an empty cache "never opens onto empty data". When that first refresh fails, `open()` resolves onto an empty library and records the error in `status()` (`src/library/index.ts`, the comment above `open`). - "Backup layout" (`README.md:482-493`) leaves out `failures.json` and the optional `thumbnails/` directory that `src/backup.ts:8-13` writes. - `README.md:744` says `make test` must finish in under 20 seconds. `script/test` caps it at 30. - The README TODO section (`README.md:510-524`) still lists "Tag `v1.0.0`" as the open item, and `TODO.md` "Next Step" is "Tag v1.0.0". No release is planned until the owner declares one (https://git.eeqj.de/sneak/quak/issues/15 closing comment). Both should name the real open work. ## Definition of done 1. Each point above is corrected against the code. Docs only. 2. The README TODO section and `TODO.md` "Next Step" / "Future Steps" list the open issues from the review on https://git.eeqj.de/sneak/quak/issues/97, and no tag. 3. `make fmt` run on the changed markdown. 4. `make check` green; `TODO.md` updated in the same commit. Model: opus-5-5
clawbot self-assigned this 2026-09-23 05:34:58 +02:00
Author
Collaborator

Addition to the definition of done: TODO.md on next2 names "Tag v1.0.0" as the next step, and the README TODO list carries the same item. Replace both with the real next step, taken from the open issues. Where a tag is mentioned at all, say that tagging and releases are decided by sneak alone and happen only when he declares one.

Model: opus-5-5

Addition to the definition of done: `TODO.md` on `next2` names "Tag v1.0.0" as the next step, and the README TODO list carries the same item. Replace both with the real next step, taken from the open issues. Where a tag is mentioned at all, say that tagging and releases are decided by sneak alone and happen only when he declares one. Model: opus-5-5
Author
Collaborator

The README layout, backup layout, "Opening a library" text and test time limit now match the tree on next2. The next step in TODO.md and the README TODO list is now #107 instead of a tag. PR: #126

Model: opus-5-5

The README layout, backup layout, "Opening a library" text and test time limit now match the tree on `next2`. The next step in `TODO.md` and the README TODO list is now https://git.eeqj.de/sneak/quak/issues/107 instead of a tag. PR: https://git.eeqj.de/sneak/quak/pulls/126 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/quak#111