Docs-only. Replaces the stale API-reference section (which opened with a "does not fully reflect the current implementation" disclaimer) with one matching the cache/API library shipped on next, and fixes the Getting Started library snippet and the CLI-surface prose the library rewrite left wrong.
What changed:
Getting Started: the library snippet now uses Library.open(), default reads, fresh(), and Photo.original() instead of the old direct-Client example.
CLI surface: adds backup-metadata, and corrects the claim that read commands serve from the cache and refresh in the background — they force a fresh server round-trip.
API reference: rewritten to cover Library.open options (XDG cache default, refresh interval, precache, cache bounds, pools), default vs fresh() reads, the record types with snapshot()/subscribe(), albums/photos/timeline, Photo content methods, thumbnails.ensure, mldata search, backup(), the three request pools (10/5/25), and the on-disk cache layout. Notes the deferred content-hash integrity check (#68).
TODO.md and the README TODO: API-reference item marked done; next step advanced to tagging v1.0.0.
Every documented signature/behaviour was verified against the source on next. make check green.
Disclosure: the rebase onto origin/next was a no-op (branch already current), so make check was not re-run after it; the tree is byte-identical to the green run.
Docs-only. Replaces the stale API-reference section (which opened with a "does not fully reflect the current implementation" disclaimer) with one matching the cache/API library shipped on `next`, and fixes the Getting Started library snippet and the CLI-surface prose the library rewrite left wrong.
What changed:
- Getting Started: the library snippet now uses `Library.open()`, default reads, `fresh()`, and `Photo.original()` instead of the old direct-`Client` example.
- CLI surface: adds `backup-metadata`, and corrects the claim that read commands serve from the cache and refresh in the background — they force a fresh server round-trip.
- API reference: rewritten to cover `Library.open` options (XDG cache default, refresh interval, precache, cache bounds, pools), default vs `fresh()` reads, the record types with `snapshot()`/`subscribe()`, `albums`/`photos`/`timeline`, `Photo` content methods, `thumbnails.ensure`, `mldata` search, `backup()`, the three request pools (10/5/25), and the on-disk cache layout. Notes the deferred content-hash integrity check (https://git.eeqj.de/sneak/quak/issues/68).
- `TODO.md` and the README TODO: API-reference item marked done; next step advanced to tagging v1.0.0.
Also issue https://git.eeqj.de/sneak/quak/issues/13.
Every documented signature/behaviour was verified against the source on `next`. `make check` green.
Disclosure: the rebase onto `origin/next` was a no-op (branch already current), so `make check` was not re-run after it; the tree is byte-identical to the green run.
Closes https://git.eeqj.de/sneak/quak/issues/53.
Model: opus-4-8
Replace the stale, disclaimer-topped API reference with one that matches the
cache/API library on `next`, and fix the Getting Started library snippet and
CLI-surface prose that the library rewrite left wrong. Documents `Library.open`
and its options (XDG cache default, refresh interval, precache, cache bounds,
pools), the default-read vs `fresh()` distinction and that the CLI's read
commands are fresh, the record types with `snapshot()`/`subscribe()`, the
`albums`/`photos`/`timeline` read surface, `Photo` content methods,
`thumbnails.ensure`, the `mldata` search surface, `backup()`, the three request
pools (10/5/25), and the on-disk cache layout. Notes the deferred content-hash
integrity check (issue #68). Also this is issue #13.
Docs-only: no code changed. Every documented signature was verified against the
source on `next`.
Model: opus-4-8
Every documented signature, option default, and behavioural claim in the rewritten API reference — Library.open options (XDG <cache>/quak/<userID>, refreshIntervalSeconds 3, precache on/on/7d, 100 GiB / 50 GiB bounds, 10/5/25 pools), default reads vs fresh(), the albums/photos/timeline surface, Photo.original/thumbnail, thumbnails.ensure, the mldata search methods, snapshot()/subscribe(), the record shapes, backup(), the on-disk cache layout, the deferred integrity check (#68), and the CLI commands with --cache-dir and fresh reads — matches the source on next, and the Getting Started snippet runs as written.
Disclosure: verified formatting with host make fmt-check and ran make test (both green); did not run the Docker lint stage, as this is docs-only and host prettier is the lockfile-pinned version.
Disclosure: rebase onto current next was a no-op (branch already current); gated against origin/next, mergeable.
Model: opus-4-8
**PASS**
Every documented signature, option default, and behavioural claim in the rewritten API reference — `Library.open` options (XDG `<cache>/quak/<userID>`, `refreshIntervalSeconds` 3, precache on/on/7d, 100 GiB / 50 GiB bounds, 10/5/25 pools), default reads vs `fresh()`, the `albums`/`photos`/`timeline` surface, `Photo.original`/`thumbnail`, `thumbnails.ensure`, the `mldata` search methods, `snapshot()`/`subscribe()`, the record shapes, `backup()`, the on-disk cache layout, the deferred integrity check (#68), and the CLI commands with `--cache-dir` and fresh reads — matches the source on `next`, and the Getting Started snippet runs as written.
Disclosure: verified formatting with host `make fmt-check` and ran `make test` (both green); did not run the Docker lint stage, as this is docs-only and host prettier is the lockfile-pinned version.
Disclosure: rebase onto current `next` was a no-op (branch already current); gated against `origin/next`, mergeable.
Model: opus-4-8
clawbot
merged commit fe952d3e62 into next2026-09-23 00:27:31 +02:00
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Docs-only. Replaces the stale API-reference section (which opened with a "does not fully reflect the current implementation" disclaimer) with one matching the cache/API library shipped on
next, and fixes the Getting Started library snippet and the CLI-surface prose the library rewrite left wrong.What changed:
Library.open(), default reads,fresh(), andPhoto.original()instead of the old direct-Clientexample.backup-metadata, and corrects the claim that read commands serve from the cache and refresh in the background — they force a fresh server round-trip.Library.openoptions (XDG cache default, refresh interval, precache, cache bounds, pools), default vsfresh()reads, the record types withsnapshot()/subscribe(),albums/photos/timeline,Photocontent methods,thumbnails.ensure,mldatasearch,backup(), the three request pools (10/5/25), and the on-disk cache layout. Notes the deferred content-hash integrity check (#68).TODO.mdand the README TODO: API-reference item marked done; next step advanced to tagging v1.0.0.Also issue #13.
Every documented signature/behaviour was verified against the source on
next.make checkgreen.Disclosure: the rebase onto
origin/nextwas a no-op (branch already current), somake checkwas not re-run after it; the tree is byte-identical to the green run.Closes #53.
Model: opus-4-8
PASS
Every documented signature, option default, and behavioural claim in the rewritten API reference —
Library.openoptions (XDG<cache>/quak/<userID>,refreshIntervalSeconds3, precache on/on/7d, 100 GiB / 50 GiB bounds, 10/5/25 pools), default reads vsfresh(), thealbums/photos/timelinesurface,Photo.original/thumbnail,thumbnails.ensure, themldatasearch methods,snapshot()/subscribe(), the record shapes,backup(), the on-disk cache layout, the deferred integrity check (#68), and the CLI commands with--cache-dirand fresh reads — matches the source onnext, and the Getting Started snippet runs as written.Disclosure: verified formatting with host
make fmt-checkand ranmake test(both green); did not run the Docker lint stage, as this is docs-only and host prettier is the lockfile-pinned version.Disclosure: rebase onto current
nextwas a no-op (branch already current); gated againstorigin/next, mergeable.Model: opus-4-8