Skip to content

docs: README accuracy (Collections, notifications, open-count wording, endpoints)#9

Merged
TrueLineCollective merged 1 commit into
mainfrom
feat/readme-accuracy
Jun 30, 2026
Merged

docs: README accuracy (Collections, notifications, open-count wording, endpoints)#9
TrueLineCollective merged 1 commit into
mainfrom
feat/readme-accuracy

Conversation

@TrueLineCollective

Copy link
Copy Markdown
Owner

Fixes from a fresh-eyes review of the public repo:

  • Add Collections and open-notifications (email/webhook) to "What it does today" and the shipped list. Both are shipped and navigable but were missing from the feature lists, which the README promises to keep honest.
  • Correct "watch open counts climb in real time": the Routes board is server-rendered with no live polling, so it reflects the latest on each load, not in real time.
  • Document the key-lifecycle endpoints (POST /api/keys, /api/keys/revoke) and note where notification channels are configured.
    Docs-only; no code change.

@TrueLineCollective TrueLineCollective merged commit 6b700c0 into main Jun 30, 2026
6 checks passed
@TrueLineCollective TrueLineCollective deleted the feat/readme-accuracy branch June 30, 2026 19:10
TrueLineCollective added a commit that referenced this pull request Jun 30, 2026
…only)

Sentou no longer persists an unverified address. A record-only gate
(requireEmail without verifyEmail) still grants access on a typed email as
friction, but the email is treated as a transient session claim (sealed in the
cookie for the domain-allowlist check) and is never written to viewers[].
Tracking attributes an open to a viewer's email only when that email was
verified, otherwise "anon".

Mechanically: the access claim carries a `verified` flag, set true only by the
one-time-code verify route (the sole path that calls recordViewer); the
record-only access route mints an unverified token and stores nothing.

This turns the audit's data-minimization finding into a clean promise: Sentou
never stores an email it hasn't verified. Docs (README + SECURITY) updated to
match. 129 tests + tsc + lint + build green; live-smoked both gate modes
(record-only stores [], verify stores the verified address).
TrueLineCollective added a commit that referenced this pull request Jun 30, 2026
docs: README accuracy (Collections, notifications, open-count wording, endpoints)
TrueLineCollective added a commit that referenced this pull request Jun 30, 2026
docs: README accuracy (Collections, notifications, open-count wording, endpoints)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant