Item 15 of 15 of #168: "Describe the implemented model in README.md in the chosen words". Starts when the item before it (one table of settings) is squash-merged to next; it is the last of the fifteen.
Today (next at 989da78)
README.md's Design section describes storage that the items before this one change, and the repo has no one place that defines its nouns.
Definition of done
README.md's Design section starts with a short Concepts list: source, variant, variant key, signed URL, encrypted URL, failed fetch (the negative cache), disk cache limit, and any other noun the code's package and type names use for what pixa keeps or serves, each in one sentence, using the names the code uses when this is built.
Every other part of the Design section (Storage, Routes, Architecture) matches the code at that point, with no directory, file, table or type that no longer exists.
No noun the code does not use is introduced; the renames in the Names section of #168 that the items before this one did not make are not part of this item.
Approval and tests
sneak asked for each main recommendation of #168 to be its own issue, built before 1.0, one at a time in the order listed (#168 (comment)). That instruction is his approval of this item. It changes documentation only and no test.
Model: opus-5-5
Item 15 of 15 of https://git.eeqj.de/sneak/pixa/issues/168: "Describe the implemented model in `README.md` in the chosen words". Starts when the item before it (one table of settings) is squash-merged to `next`; it is the last of the fifteen.
## Today (`next` at `989da78`)
`README.md`'s Design section describes storage that the items before this one change, and the repo has no one place that defines its nouns.
## Definition of done
- `README.md`'s Design section starts with a short Concepts list: source, variant, variant key, signed URL, encrypted URL, failed fetch (the negative cache), disk cache limit, and any other noun the code's package and type names use for what pixa keeps or serves, each in one sentence, using the names the code uses when this is built.
- Every other part of the Design section (Storage, Routes, Architecture) matches the code at that point, with no directory, file, table or type that no longer exists.
- No noun the code does not use is introduced; the renames in the Names section of https://git.eeqj.de/sneak/pixa/issues/168 that the items before this one did not make are not part of this item.
## Approval and tests
sneak asked for each main recommendation of https://git.eeqj.de/sneak/pixa/issues/168 to be its own issue, built before 1.0, one at a time in the order listed (https://git.eeqj.de/sneak/pixa/issues/168#issuecomment-153513). That instruction is his approval of this item. It changes documentation only and no test.
Model: opus-5-5
clawbot
added this to the 1.0.0 milestone 2026-10-21 12:51:27 +02:00
clawbot
self-assigned this 2026-10-21 12:51:27 +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.
Item 15 of 15 of #168: "Describe the implemented model in
README.mdin the chosen words". Starts when the item before it (one table of settings) is squash-merged tonext; it is the last of the fifteen.Today (
nextat989da78)README.md's Design section describes storage that the items before this one change, and the repo has no one place that defines its nouns.Definition of done
README.md's Design section starts with a short Concepts list: source, variant, variant key, signed URL, encrypted URL, failed fetch (the negative cache), disk cache limit, and any other noun the code's package and type names use for what pixa keeps or serves, each in one sentence, using the names the code uses when this is built.Approval and tests
sneak asked for each main recommendation of #168 to be its own issue, built before 1.0, one at a time in the order listed (#168 (comment)). That instruction is his approval of this item. It changes documentation only and no test.
Model: opus-5-5