96dd878ac5
Period was a bare directory holding one 2,527-line specification, with no git
repository, no tracker and no documentation convention. This is the adoption
from Projects/Template/START-HERE-New-Project.md, plus a project that compiles
so the hooks and future guards have something real to run against.
Documents. scaffold.sh created 19 paths, 0 skipped. The specification moved to
docs/planning/PRODUCT_PLAN.md unchanged in substance, with a status header; the
capitalised Docs/ is gone. Every scaffolded document was filled in for Period.
docs/OPERATIONS.md deleted — an offline app is not a deployed service.
DOC_TRUST_MAP.md written last, describing what is actually here, including what
this project deliberately does not have.
Code. Four Gradle modules. domain/cycle and domain/prediction are kotlin("jvm")
and cannot see the Android SDK, so the engine is testable without an emulator —
17 tests pass, 12 of them the acceptance cases from PRODUCT_PLAN.md §51.
BaselinePredictionEngine is a robust-median prototype and explicitly not the
product; it exists so Batch 02's replacement can be shown to be better rather
than merely different.
Versions verified against their official sources today rather than inherited
from the specification's own numbers, which that document asks for: Kotlin
2.4.10, AGP 9.3.1, Gradle 9.7.0, Compose BOM 2026.08.00, Room 2.8.4, Hilt
2.60.1. AGP 9 ships Kotlin built in, so org.jetbrains.kotlin.android is no
longer applied. compileSdk is 37 because current AndroidX requires it; targetSdk
stays 36, Play's floor from 2026-08-31, and the difference is deliberate.
Six scripts taken into scripts/; the rest declined and named in docs/TOOLS.md.
Three hooks in .githooks/, with pre-commit adapted to Gradle.
closes #1
closes #2
|
||
|---|---|---|
| .. | ||
| README.md | ||
README.md
Project images
Status: Current
Owner: _null
Last reviewed: 2026-08-18
Governs: docs/data/img/** — the three files and their sizes
Review trigger: A rebrand; any change to a required name, dimension or ceiling;
any change to what the consumer accepts.
Three files, all webp, all required, at exactly these names:
| File | Dimensions | Aspect | Typical weight |
|---|---|---|---|
icon.webp |
512 × 512 | 1:1 | 8–60 KB |
logo.webp |
1024 on the long edge | whatever the lockup is | 20–190 KB |
banner.webp |
2176 × 725 | 3:1 | 30–130 KB |
Not icon.ico. The consumer checks the file's magic bytes, not its name: a
.ico, or a PNG renamed to .webp, is refused with a 415 and the project falls
back to an initials tile. That signature check is what makes it safe to render
these inline, so it is not going to be relaxed.
512 KB is a hard ceiling per file, enforced in code — the size is read from the listing before the bytes are fetched, so an oversized asset is never downloaded and simply never appears. Nothing enforces the dimensions, which is why they are written down.
Making them
magick logo-source.png -resize 512x512 -quality 82 icon.webp
identify -format '%f %wx%h %b\n' *.webp # check before committing
Quality 80–85 suits a flat mark. If a file lands over ~200 KB it is usually a photographic banner that wants a lower quality rather than fewer pixels.
Why these numbers
The icon renders small — a 44 px tile in a list, 58 px on a project header — so 512 covers the densest display several times over; the reference project deliberately halved it from 1024. The banner spans a card about 760 px wide, so ~2176 covers it at 2×, and its 3:1 shape matters more than its width because the header crops to fill. The logo has no fixed frame, so only its long edge is specified.
Extra sizes and variants are welcome beside these — icon-512.webp,
logo-dark.webp. Only the three exact names are checked for.
No placeholders ship with this template. An empty file is the worst of the three states: a check that asks whether the path exists calls it present, and anything reading the bytes rejects it. Absent is honest, and the conformance check reports it as absent — which is what gets it filled in.
Why the requirement exists, and what reads it: ../README.md.