From 2cdec0ccd3ec1fdcafdc4f12fb30c7d58c7632b8 Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Fri, 19 Jun 2026 21:03:03 +0300 Subject: docs: split README into quick-start + reference pages under docs/ Trim README.md to a quick-start guide (install, init, generate, sync, clean) with a main-flags table and feature-toggle summary, and move the detailed reference material into focused pages under docs/: installation, usage, configuration, generation, publishing, templates. Correctness fixes carried over during the split: - The 'Site generated ... with ' source link lives in the page header bar (header.tmpl), not the footer (footer.tmpl only renders the tarball download). Fixed in docs and the SOURCE_URL code comment. - --sync is a config-backed action and accepts --config PATH / reads ./shuriken.conf; the --config action list now includes it. - --refresh-splash also re-copies the site favicon; documented. - State the Bash 5.1 requirement (enforced by the script) in the docs. - docs/stats-exif-audit.md: the EXIF cache moved to metadata-cache.source.sh and the native-field parser extension was implemented; add a status note and fix the stale module path. bin/shuriken regenerated from the config.source.sh comment change. --- docs/stats-exif-audit.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'docs/stats-exif-audit.md') diff --git a/docs/stats-exif-audit.md b/docs/stats-exif-audit.md index 1b1023b..2da9cae 100644 --- a/docs/stats-exif-audit.md +++ b/docs/stats-exif-audit.md @@ -1,5 +1,13 @@ # Stats Page EXIF Field Coverage Audit +> **Status note (added after implementation):** This is a historical design +> record from task `nm0`. The stats site it scopes has since been implemented +> (`src/lib/stats-aggregate.source.sh`, `src/lib/stats-render.source.sh`, +> `src/lib/stats-filter-album.source.sh`), including the "native-field parser +> extension" described below as required work — `Geometry`/`Format` lines are +> now read alongside the `exif:` lines. The verdicts and decode maps below +> remain accurate as a description of what the EXIF data can and cannot support. + Task `nm0` for the stats site feature (see `/home/paul/.pi/plans/shuriken-stats-site.md`). This document decides which of the planned stats categories are actually buildable from the EXIF/identify data @@ -13,8 +21,10 @@ library (there is none to point at): * `src/lib/imagemagick.source.sh` runs `magick identify -verbose ` (or `convert -verbose info:` when only the legacy `convert` is present). -* `src/lib/album.source.sh` caches that raw output per photo under a volatile - `./cache/exif/.txt` (parallel to `./dist`) and parses it. +* The shared EXIF cache in `src/lib/metadata-cache.source.sh` (promoted out of + the album module after this audit was written) caches that raw output per + photo under a volatile `./cache/exif/.txt` (parallel to `./dist`); + `src/lib/album-metadata.source.sh` parses it. The parser detail that drives every decision below: shuriken only reads EXIF through this regex (`photo_exif_details_html`, `_photo_exif_values_to`): -- cgit v1.2.3