chore: rename the project to Privacy: Period Tracker
"Period" was always a working name — PRODUCT_PLAN.md §55 said so. The real
identity arrived with the brand guide and artwork, and this makes the project
call itself by it.
The repository is renamed in place on Forgejo (null/Period ->
null/Privacy-Period-Tracker), which keeps all 30 commits, all 27 issues, all 8
milestones and the four severity labels — verified by counting them on both
sides rather than assuming a rename is lossless. The git remote follows in the
same breath, so this commit's automatic push is what proves the new URL works.
WHAT DELIBERATELY DID NOT MOVE
"Period" is the product name AND the central domain word, and a mass rename
would have turned the data model into nonsense. PeriodRecord, PeriodWriteResult,
confirmPeriodStart, the period_records table and the button that says "Started
period" all describe a menstrual period rather than a product, and all 239
references to them are untouched.
So are the Kotlin package and applicationId. dev.privacyllc.period already reads
correctly under the new name — privacyllc is the company, period is the app —
and changing it would rewrite 68 files, rename the Room schema directory and
break the hardcoded path in schema-guard.sh for no gain. period.db stays for a
sharper reason: renaming a database file orphans the data on every device that
already has it.
Sixteen files changed, and the diff is small on purpose.
THE NAME HAS A SPACE AND THE ARTWORK DOES NOT
Canonical is "Privacy: Period Tracker". The supplied wordmark sets it without
one, so logo.webp and banner.webp now disagree with every document and with the
app itself. BRAND_GUIDE.md §10 is updated to the space form and says plainly
that the drawn mark has not caught up. Filed separately rather than papered
over, because closing that gap needs an artist and not a rename.
2026-08-18 15:54:34 -05:00
|
|
|
# Data — Privacy: Period Tracker
|
chore: adopt the project template and add the Kotlin/Compose skeleton
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
2026-08-18 02:16:47 -05:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
Status: Current
|
|
|
|
|
Owner: _null
|
|
|
|
|
Last reviewed: 2026-08-18
|
|
|
|
|
Governs: docs/data/** — the assets privacyllc.dev renders for this project
|
|
|
|
|
Review trigger: A rebrand, or any change to the icon, logo or banner
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## What goes here
|
|
|
|
|
|
|
|
|
|
Three files, in `img/`, at exactly these names:
|
|
|
|
|
|
|
|
|
|
```text
|
|
|
|
|
docs/data/img/icon.webp the square mark, used wherever the project is listed
|
|
|
|
|
docs/data/img/logo.webp the full lockup, used on the project page
|
|
|
|
|
docs/data/img/banner.webp the wide image, used across the project header
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
All **webp**. All **required**. Only `img/` is checked — an asset left in
|
|
|
|
|
`docs/data/` instead of `docs/data/img/` is not found.
|
|
|
|
|
|
|
|
|
|
**Dimensions, weights and how to generate them are in
|
|
|
|
|
[`img/README.md`](img/README.md)**, beside the files they describe. This
|
|
|
|
|
document owns the rule; that one owns the spec. Stating both in both places is
|
|
|
|
|
how two copies of one convention start disagreeing.
|
|
|
|
|
|
docs: correct 57 claims the code and tracker disagreed with
Every document in the tree audited against the source, the tracker and git
history, each finding then given to a second reader tasked with refuting it.
74 raised, 12 refuted, 57 applied. No code changed.
THE README DESCRIBED A SKELETON
Its Status table — the one place a claim about what is built is allowed to live
— still read "there is no usable app yet", with Not built against Room, the four
core screens, fertility and notifications, and No round run against QA. Five
batches had shipped and three QA rounds had run.
TWO DOCUMENTS WERE SILENTLY NEVER FIRING
architecture/README.md and design/README.md wrote Governs: as prose ("the Gradle
module graph", "the design tokens in core/designsystem"). Neither contains a
path token, so doc-triggers.py reduced them to globs matching nothing, and one
real glob apiece made them look path-governing rather than subject-governing —
the state the script's own header calls invisible. Editing a Room entity never
fired the document owning the migration table. Both now fire, proved by running
the script.
SECURITY.md CLAIMED FOUR UNBUILT PROTECTIONS
App lock listed among what works offline; biometric/PIN gating described as
protecting app launch; the incognito launcher as existing; Play Billing in the
third parties table without the "not yet integrated" marker its neighbours
carry. All are Batch 06/07 work.
The advertising boundary was overstated in SECURITY.md and the README alike:
both said the ads module declares no dependency and a guard proves it. There is
no ads module. The pre-declared ":core:ads" to emptySet() rule is stricter than
the sentence it replaced and matches nothing until Batch 07, which is why the
guard is proved by injection rather than trusted.
SMALLER, EACH A REAL TRAP
WORK_CYCLE.md pointed at docs/architecture/scripts/forgejo-issue.py, a template
path absent here — missed by doc-claims.sh, which reads backticked prose and not
fenced blocks. ClaudeReport.md's Round notes said "No rounds yet" after three
rounds because ClaudeQAPlan.md's after-a-round list never named that section;
the playbook is fixed first. The instrumented-test count was eight in three
places and is four. HISTORY.md said the repository had no code and that nothing
had been tried and dropped, when three approaches had.
DELIBERATELY UNCHANGED
ClaudeReport.md's last verified build SHA stays at 0451fbe — no round has run
since, and moving it would claim a verification nobody performed. Every
DEVELOPMENT_LOG entry stays as written.
Guards: ./gradlew check, schema-guard.sh, doc-claims.sh (235 claimed paths, all
present), doc-triggers.py, and a link sweep over 21 markdown files.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-18 16:33:14 -05:00
|
|
|
**No placeholders ship here, deliberately.** The template this repository
|
|
|
|
|
adopted carried a 0-byte `logo.webp` once, and an empty file is the worst of the
|
|
|
|
|
three states: a check that asks "does the path exist" calls it present, and
|
|
|
|
|
anything that reads the bytes rejects it — a consumer verifying the webp signature answers 415, which
|
chore: adopt the project template and add the Kotlin/Compose skeleton
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
2026-08-18 02:16:47 -05:00
|
|
|
reads as a corrupt asset rather than a missing one. Absent is honest and the
|
|
|
|
|
conformance check reports it as absent, which is what gets it filled in.
|
|
|
|
|
|
|
|
|
|
Extra sizes and variants are welcome beside them — `icon-512.webp`,
|
|
|
|
|
`logo-dark.webp` — and are not treated as clutter. Only the three exact names
|
|
|
|
|
are checked for.
|
|
|
|
|
|
|
|
|
|
## If an asset is missing, open an issue — do not invent one
|
|
|
|
|
|
|
|
|
|
An agent cannot draw a logo, and this is the one gap in the whole convention
|
|
|
|
|
that cannot be closed by writing a file.
|
|
|
|
|
|
|
|
|
|
So when an asset is absent, **file an issue** rather than producing something:
|
|
|
|
|
title it for the asset, label it `P2`, and end the body with its `Verify:` line
|
|
|
|
|
— `Verify: docs/data/img/logo.webp exists and the project card renders it.`
|
|
|
|
|
|
|
|
|
|
**Do not generate a placeholder.** A placeholder that looks deliberate outlives
|
|
|
|
|
the issue that would have replaced it: nobody files a ticket against an image
|
|
|
|
|
that appears to be finished. An obviously absent asset keeps asking.
|
|
|
|
|
|
|
|
|
|
## Why this folder is different from every other one here
|
|
|
|
|
|
|
|
|
|
The Command Center *consumes* these. Every other document in this tree is written
|
|
|
|
|
for a person to read; these are fetched and rendered on privacyllc.dev's project
|
|
|
|
|
page.
|
|
|
|
|
|
|
|
|
|
That has one consequence worth stating plainly: **this folder cannot be declared
|
|
|
|
|
exempt.** A repository may tell the conformance check that a required document is
|
|
|
|
|
deliberately absent — kept out of git on purpose, say — and the check will
|
|
|
|
|
believe it. It will not accept that declaration for `docs/data/`, because the
|
|
|
|
|
result would be a project card with nothing to show and nothing explaining why,
|
|
|
|
|
which is the exact failure the check exists to prevent.
|
|
|
|
|
|
|
|
|
|
## Why webp and not PNG
|
|
|
|
|
|
|
|
|
|
One format, checked by its magic bytes rather than its file extension, so the
|
|
|
|
|
site can serve it inline with confidence. A file whose first bytes are RIFF/WEBP
|
|
|
|
|
cannot be an HTML document or an SVG carrying script, which is what makes it safe
|
|
|
|
|
to render directly rather than forcing a download.
|
|
|
|
|
|
|
|
|
|
Renaming a PNG to `.webp` will not work, and is meant not to.
|
|
|
|
|
|
|
|
|
|
## This is not an asset library
|
|
|
|
|
|
|
|
|
|
Screenshots, mockups, reference art and exported source files do not belong here.
|
|
|
|
|
They belong wherever the project already keeps them. This folder holds the three
|
|
|
|
|
marks that identify the project elsewhere, and stays small enough that its
|
|
|
|
|
contents are obvious at a glance.
|