sneak/quak
1
0
Fork 0
Code Issues 8 Pull Requests 2 Actions Packages Projects Releases Wiki Activity

Rewrite the README API reference for the new library surface #53

New Issue
Closed
opened 2026-09-22 09:11:14 +02:00 by clawbot · 1 comment
clawbot commented 2026-09-22 09:11:14 +02:00
Collaborator
Copy Link
Copy Source

Cache/API implementation (#36), phase 5.
Depends on the CLI-port unit (the surface must be final). This is
#13.

Goal

Rewrite the README API reference section to document the new library surface
exactly as implemented.

Scope

  • Rewrite the "API reference" section (and any Getting Started / usage snippets
    that changed) to match the shipped Library surface: Library.open args,
    the record types, snapshot/subscribe, albums/photos/timeline,
    Photo.original/thumbnail, thumbnails.ensure, mldata.*, backup,
    status, and the directory options (cacheDirectory/downloadDirectory,
    --cache-dir).
  • Every documented signature and behaviour must match the code (a doc that
    promises what the code does not do is a defect — this is a docs-only unit and
    gets an independent reviewer who checks every sentence against the tree).
  • Update TODO.md accordingly.
  • Docs-only: touch only docs and TODO.md. Run make fmt (prettier, 4-space,
    proseWrap: always) before committing.

Definition of done

  • README API reference matches the implementation; TODO.md current;
    make check/make fmt-check green. Closes
    #13.

Grounding

README.md, TODO.md.

Dispatch notes: no scripted edits; no interactive questions; plain language.
Squash subject ends (closes #<this issue>). End every message with
Model: opus-4-8.

Model: opus-4-8

Cache/API implementation (https://git.eeqj.de/sneak/quak/issues/36), phase 5. Depends on the CLI-port unit (the surface must be final). This is https://git.eeqj.de/sneak/quak/issues/13. ## Goal Rewrite the README API reference section to document the new library surface exactly as implemented. ## Scope - Rewrite the "API reference" section (and any Getting Started / usage snippets that changed) to match the shipped `Library` surface: `Library.open` args, the record types, `snapshot`/`subscribe`, `albums`/`photos`/`timeline`, `Photo.original`/`thumbnail`, `thumbnails.ensure`, `mldata.*`, `backup`, `status`, and the directory options (`cacheDirectory`/`downloadDirectory`, `--cache-dir`). - Every documented signature and behaviour must match the code (a doc that promises what the code does not do is a defect — this is a docs-only unit and gets an independent reviewer who checks every sentence against the tree). - Update `TODO.md` accordingly. - Docs-only: touch only docs and `TODO.md`. Run `make fmt` (prettier, 4-space, `proseWrap: always`) before committing. ## Definition of done - README API reference matches the implementation; `TODO.md` current; `make check`/`make fmt-check` green. Closes https://git.eeqj.de/sneak/quak/issues/13. ## Grounding `README.md`, `TODO.md`. Dispatch notes: no scripted edits; no interactive questions; plain language. Squash subject ends ` (closes #<this issue>)`. End every message with `Model: opus-4-8`. Model: opus-4-8
clawbot commented 2026-09-23 00:09:15 +02:00
Author
Collaborator
Copy Link
Copy Source

Rewrote the README API reference to match the cache/API library shipped on next, and fixed the Getting Started library snippet and the CLI-surface prose the library rewrite had left wrong (read commands now force a fresh server round-trip, not background refresh; added backup-metadata). The reference now documents Library.open and its options, default reads vs fresh(), the record types with snapshot()/subscribe(), the albums/photos/timeline surface, Photo content methods, thumbnails.ensure, mldata search, backup(), the three request pools (10/5/25), and the on-disk cache layout; it notes the deferred content-hash integrity check (#68). Every signature was verified against the source on next. Docs-only.

Also issue #13.

PR: #77

Model: opus-4-8

Rewrote the README API reference to match the cache/API library shipped on `next`, and fixed the Getting Started library snippet and the CLI-surface prose the library rewrite had left wrong (read commands now force a fresh server round-trip, not background refresh; added `backup-metadata`). The reference now documents `Library.open` and its options, default reads vs `fresh()`, the record types with `snapshot()`/`subscribe()`, the `albums`/`photos`/`timeline` surface, `Photo` content methods, `thumbnails.ensure`, `mldata` search, `backup()`, the three request pools (10/5/25), and the on-disk cache layout; it notes the deferred content-hash integrity check (https://git.eeqj.de/sneak/quak/issues/68). Every signature was verified against the source on `next`. Docs-only. Also issue https://git.eeqj.de/sneak/quak/issues/13. PR: https://git.eeqj.de/sneak/quak/pulls/77 Model: opus-4-8
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
merge-ready
Review passed; ready to merge
 needs-checks
CI / make check is not green on this PR
 needs-rebase
PR conflicts with main and must be rebased
 needs-review
PR is awaiting adversarial review
 needs-rework
Review failed; PR needs changes
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
clawbot sneak (Jeffrey Paul)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sneak/quak#53