docs: bring all documentation current with shipped work #244

2026-06-10T21:05:45-04:00

justin commented

2026-06-10 21:05:45 -04:00

A multi-agent audit of all 7 doc files against the actual code found ~50 stale/missing items — the roadmap/status docs and the backlog had drifted behind a heavy session of shipping. This catches everything up (docs-only, no code).

Highlights

CLAUDE.md — phase status was ~3 phases stale; rewrote it, added the model-provider tech-stack entry + repo-layout fixes.
ARCHITECTURE.md §6 — privacy engine described 3 visibility levels; corrected to the shipped 4 (adds site_members). Also documented per-tree AI policy, the LLMProvider/EmbeddingProvider split + registry, ChangeProposal fields, the verified-email gate, the instance-owner role, the schema-drift guard, and the env_file config model.
BACKLOG.md — flipped ~15 shipped-but-open rows to Have (ChangeProposal, providers, GEDCOM citations, membership, backup, email-gate, per-tree AI policy, instance owner, and the whole visibility/public-viewing/child-resource-redaction cluster #41-#51/#46); reconciled the exec summary, defects list, quick wins, and differentiators. Genuinely-open items (citation/source redaction, sitemap, per-tree noindex, scoped-token API) kept accurately open.
PRD.md / README.md — 4-level visibility, instance-owner role, per-tree AI policy, §8 sequencing annotated; README softened "Full GEDCOM 7" and moved property/land to an explicit "where it's headed" (no property models exist yet).
.env.example — SMTP no longer "later phase"; added purge knobs + S3_PRESIGN_TTL + COOKIE_NAME; removed a stray line.
design docs — marked Shipped; fixed the redaction-approach description (reuses member schemas, not a separate PublicPersonRead) and the apply() rollback claim (v1 is not cross-op transactional).

Every status flip was verified against code; delegated edits were reviewed before merge.

🤖 Generated with Claude Code

A multi-agent audit of all 7 doc files against the actual code found ~50 stale/missing items — the roadmap/status docs and the backlog had drifted behind a heavy session of shipping. This catches everything up (docs-only, no code). **Highlights** - **CLAUDE.md** — phase status was ~3 phases stale; rewrote it, added the model-provider tech-stack entry + repo-layout fixes. - **ARCHITECTURE.md §6** — privacy engine described **3** visibility levels; corrected to the shipped **4** (adds `site_members`). Also documented per-tree AI policy, the `LLMProvider`/`EmbeddingProvider` split + registry, ChangeProposal fields, the verified-email gate, the instance-owner role, the schema-drift guard, and the `env_file` config model. - **BACKLOG.md** — flipped ~15 shipped-but-open rows to **Have** (ChangeProposal, providers, GEDCOM citations, membership, backup, email-gate, per-tree AI policy, instance owner, and the whole visibility/public-viewing/child-resource-redaction cluster #41-#51/#46); reconciled the exec summary, defects list, quick wins, and differentiators. Genuinely-open items (citation/source redaction, sitemap, per-tree noindex, scoped-token API) kept accurately open. - **PRD.md / README.md** — 4-level visibility, instance-owner role, per-tree AI policy, §8 sequencing annotated; README softened "Full GEDCOM 7" and moved property/land to an explicit "where it's headed" (no property models exist yet). - **.env.example** — SMTP no longer "later phase"; added purge knobs + `S3_PRESIGN_TTL` + `COOKIE_NAME`; removed a stray line. - **design docs** — marked Shipped; fixed the redaction-approach description (reuses member schemas, not a separate `PublicPersonRead`) and the `apply()` rollback claim (v1 is not cross-op transactional). Every status flip was verified against code; delegated edits were reviewed before merge. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

justin added 1 commit 2026-06-10 21:05:46 -04:00

docs: bring all documentation current with shipped work 447daf7fa8

A multi-agent audit of every doc against the code surfaced ~50 stale/missing
items (the roadmap/status docs and the backlog had fallen behind the code).
This catches them up:

- CLAUDE.md: phase status was ~3 phases stale ("Phase 1 is next" while Phase 1 +
  chunks of 2 & 4 shipped). Rewrote the status list; added a model-provider
  tech-stack entry; updated repo-layout (integrations objectstore/models,
  deploy backup.sh/dev compose).
- ARCHITECTURE.md: §6 privacy engine described 3 visibility levels — corrected to
  the shipped 4 (adds site_members); documented per-tree AI policy on Tree,
  LLMProvider/EmbeddingProvider split + registry, ChangeProposal origin/status/
  operations, verified-email session gate, instance-owner role, schema-drift
  guard, and the env_file config model.
- PRD.md: 4-level visibility in US-040/§5.5, instance-owner role (§5.1/§5.11),
  per-tree AI policy (§5.8), §8 sequencing annotated with shipped status, header
  date/status bumped.
- README.md: 4-level privacy; softened "Full GEDCOM 7" to the 5.5.1/7 common
  subset; noted backups + instance-owner admin; moved property/land to an
  explicit "where it's headed" (no property models exist yet).
- BACKLOG.md: flipped ~15 shipped-but-open rows to Have (ChangeProposal, provider
  abstraction, GEDCOM citation export, membership management, operator backup,
  email-verification gate, per-tree AI policy, instance owner, the whole
  visibility/public-viewing/child-resource-redaction cluster #41-#51/#46), and
  reconciled the executive summary, "current defects" list, quick wins, and
  differentiators. Left genuinely-open items (citation/source redaction, sitemap,
  per-tree noindex, scoped-token API) accurately open.
- .env.example: dropped "SMTP wired in a later phase"; documented the worker
  purge knobs, S3_PRESIGN_TTL, COOKIE_NAME; removed a stray duplicate line.
- design/: tree-visibility.md and change-proposal.md marked Shipped; corrected
  the redaction approach (reuses member schemas, not a separate PublicPersonRead)
  and the apply() rollback claim (v1 is not cross-op transactional), and marked
  rate-limiting/sitemap/noindex as deferred.

No code changes.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Signed-off-by: Justin Paul <justin@jpaul.me>

justin merged commit 7ed3ddd448 into main

2026-06-10 21:05:47 -04:00

justin deleted branch docs-catch-up

2026-06-10 21:05:47 -04:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: justin/provenance#244