README.md described storage paths, formats and features that do not match the code (#74). Per the plan on that issue:
Storage names the directories pixa uses (cache/sources, cache/metadata, cache/variants) and how files are named in each, as internal/imgcache/storage.go does. The comments in internal/db/migrations/001_schema.sql name the same paths. No schema change.
Formats: one list under Routes, matching what internal/imgcache/urlparser.go accepts. The signature section points to that list and says jpg is signed as jpeg and original as orig, because the parsed name is what gets signed.
TLS: the sentence now names allow_http as its one exception.
Metrics says what exists: generic HTTP and Go runtime metrics at /metrics, recorded and served only when both metrics credentials are set.
The "1-5k r/s" sentence is unchanged. Since #70 it claims only what the code does.
Disclosures:
Judgement call: the output_content comment no longer names a path. It now says nothing writes the table, because transformed images are stored as variants. Removing the unused tables is outside this issue.
Judgement call: <statedir> is now <state_dir>, the config key's name, as the Configuration section already writes it.
Deviation: make fmt formats only Go (#100). The markdown is wrapped by hand at 80 columns, in the README's existing list style.
Model: opus-5-5
`README.md` described storage paths, formats and features that do not match the code (https://git.eeqj.de/sneak/pixa/issues/74). Per the plan on that issue:
- **Storage** names the directories pixa uses (`cache/sources`, `cache/metadata`, `cache/variants`) and how files are named in each, as `internal/imgcache/storage.go` does. The comments in `internal/db/migrations/001_schema.sql` name the same paths. No schema change.
- **Formats**: one list under Routes, matching what `internal/imgcache/urlparser.go` accepts. The signature section points to that list and says `jpg` is signed as `jpeg` and `original` as `orig`, because the parsed name is what gets signed.
- **TLS**: the sentence now names `allow_http` as its one exception.
- **Metrics** says what exists: generic HTTP and Go runtime metrics at `/metrics`, recorded and served only when both metrics credentials are set.
- The "1-5k r/s" sentence is unchanged. Since https://git.eeqj.de/sneak/pixa/issues/70 it claims only what the code does.
Disclosures:
- Judgement call: the `output_content` comment no longer names a path. It now says nothing writes the table, because transformed images are stored as variants. Removing the unused tables is outside this issue.
- Judgement call: `<statedir>` is now `<state_dir>`, the config key's name, as the Configuration section already writes it.
- Deviation: `make fmt` formats only Go (https://git.eeqj.de/sneak/pixa/issues/100). The markdown is wrapped by hand at 80 columns, in the README's existing list style.
Model: opus-5-5
"Storage" names the cache directories pixa uses (cache/sources,
cache/metadata, cache/variants) and how files are named in each; the
schema comments name the same paths, and the output_content comment says
the table is not written. Routes and the signature section give one list
of output formats, jpg and original included, and say how those two are
signed. The TLS sentence names allow_http as its exception. "Metrics"
says what exists: generic HTTP and Go runtime metrics at /metrics,
measured and served only when the metrics username and password are set.
Model: opus-5-5
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.
README.mddescribed storage paths, formats and features that do not match the code (#74). Per the plan on that issue:cache/sources,cache/metadata,cache/variants) and how files are named in each, asinternal/imgcache/storage.godoes. The comments ininternal/db/migrations/001_schema.sqlname the same paths. No schema change.internal/imgcache/urlparser.goaccepts. The signature section points to that list and saysjpgis signed asjpegandoriginalasorig, because the parsed name is what gets signed.allow_httpas its one exception./metrics, recorded and served only when both metrics credentials are set.Disclosures:
output_contentcomment no longer names a path. It now says nothing writes the table, because transformed images are stored as variants. Removing the unused tables is outside this issue.<statedir>is now<state_dir>, the config key's name, as the Configuration section already writes it.make fmtformats only Go (#100). The markdown is wrapped by hand at 80 columns, in the README's existing list style.Model: opus-5-5
PASS at
f2cf9d3e52cc7a1401db816e0eed5f9846dbeaf7, rebased ontonextat00da62db2cdd4b20512e0638e331ab14d31b8c49.Model: opus-5-5