You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: post-audit cleanup across CHANGELOG, CLAUDE, PLAN, README, design, ADR 0001, UI/UX plan (#60)
Sweep over the project's markdown to bring it back in line with the
post-Phase-7 + post-audit codebase. Documentation was lagging in
multiple places — the project audit's docs front had flagged most of
this; this PR ships the fixes.
CHANGELOG.md
Repointed the `Unreleased` section to cover BOTH the existing
Phase 7 access-control + change-approval bundle (PRs #28-#32 + #37)
AND the project-audit follow-ups (PRs #52-#59) that just landed.
The audit follow-ups subsection summarises each merged PR with its
scope and verification, plus a deferred-items list (DisallowUnknownFields,
rate-limiter janitor, per-handler child spans, eager markdown
chunk). Added a note that a real version stamp is overdue.
CLAUDE.md
- Tech stack: drop the "sqlc or pgx" hedge — the codebase is pgx
+ hand-written SQL only.
- Auth bullet: stop claiming hashed API keys are supported; they're
parked under v0.4.x. Mirrored on Decision B in the table.
- Deployment bullet: stop claiming docker-compose has dev + prod
profiles. Only dev + ci exist; the prod profile is parked.
- Conventions: drop the obsolete `claude/ai-registry-setup-KMC3l`
bootstrap branch reference; describe the actual feat/fix/docs/chore
convention.
- Configuration section: "**both** of the following" → "**all three**"
(env / YAML / default). Original wording predated the YAML layer
and was only updated on the precedence list, not the lede.
PLAN.md
- Phase 5 hardening section: the four-line `**TODO — Phase 5:**`
list was misleading — the items weren't unfinished Phase 5 work,
they were carried forward into v0.4.x. Replaced with a "Parked
from Phase 5 (now tracked under v0.4.x)" header that points at
the README + CLAUDE.md Decision B for the live status.
- v0.2.2 section: the entire DoD checklist was rendered as `- [ ]`
even though the section header said "✅ SHIPPED". Replaced the
unchecked checklist with a past-tense "What landed" summary, a
"Carried forward" subsection for the OTel-spans gap that v0.2.2
only partially closed (PR #58 finished it), and a DoD-met note.
README.md
- Tech stack: PostgreSQL 16 → 18, matching the dev compose
(postgres:18-alpine since PR #41) and the Helm CNPG cluster
(PR #56).
- Infra bullet: replace the "docker-compose (dev / ci / prod)"
claim with an accurate description of the two real overlays
(dev, ci) and a parked-under-v0.4.x note for prod.
design.md
- Typography table: drop the "Geist (next/font)" row — that loader
was removed with the rest of the Next.js stack in Phase 6
(ADR 0004). The web app uses Tailwind's default `font-sans` /
`font-mono` system stacks; explained in a follow-up paragraph.
- Admin sidebar ASCII diagram: add the Workspaces nav item that
Phase 7 introduced; rename "Activity" → "Audit" to match the
actual nav label; flag the API Keys item as a placeholder.
docs/adr/0001-workspaces-under-publishers.md
- Drop the "Migration numbers ... are **placeholders**" preamble —
the actual numbered migrations (000008, 000009, 000010) are on
disk and the placeholder language is no longer accurate.
- Mark Step 1 + Step 2 as shipped with the actual entry points
(Go-side `db.BackfillWorkspaces` instead of the original
`make backfill-workspaces`).
- Add an explicit "Status note (2026-05-10)" callout that Step 3
(the finalising migration that drops `publisher_id` and flips
`workspace_id` to NOT NULL) was scoped at design time but never
landed; production keeps both columns coexisting and code paths
still read `publisher_id` directly. Verified by grep against
`internal/store/mcp.go`.
docs/ui-ux-implementation-plan.md
- Added a "Status: largely shipped — retrospective document" banner
at the top. The document plans 10 batches, the vast majority of
which shipped across v0.2.x and v0.3.x. Without the banner the
file reads as forward-looking work and gives a misleading picture
to anyone landing on it via search. Points the reader at PLAN.md
and README.md for current open work.
Out of scope (audit findings deliberately not addressed here):
docs/ui-ux-proposals.md is a decision record (proposals + accepted /
deferred verdicts), so staleness is by design — not a bug. The
runbook, db-backup, future-multi-environment, ADRs 0002/0003/0004,
and test/load README are all current.
No code changes; no test impact.
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
**Infra** — docker-compose (dev / ci / prod) · Helm chart with optional CNPG-managed PostgreSQL cluster, HTTPRoute, and Ingress · Keycloak for local OIDC · OTel Collector
63
+
**Infra** — docker-compose (`docker-compose.yml` baseline + `dev` overlay; `ci` overlay for CI only) · Helm chart with optional CNPG-managed PostgreSQL 18 cluster, HTTPRoute, and Ingress · Keycloak for local OIDC · OTel Collector. (A dedicated `docker-compose.prod.yml` profile is parked under v0.4.x.)
64
64
65
65
**API spec** — Hand-written OpenAPI 3.1 at `server/api/openapi.yaml` (**81 operations**), embedded into the binary and served live at `/openapi.yaml`. Server types and the TypeScript client are generated from the spec. A bijection test ensures the router and spec never drift.
0 commit comments