Skip to content

Handoff — Comprehensive Docs Update May 2026

Branch: docs/comprehensive-update-may-2026 Date: 2026-05-04

What Was Updated

docs/architecture/backend.md

  • Project Structure section rewritten to reflect the Phase 1 API refactor (PR #370):
  • Added api/core/ with config.py, openapi.py, and placeholder exceptions.py / logging.py
  • Added api/templates/ with contact_admin.html and contact_user.html (Jinja2 email templates)
  • Added placeholder packages: api/repositories/, api/services/, api/data/
  • Added prose explaining Phase 1 delivered zero behavior change and what subsequent phases will do
  • Added frontmatter changes entry for 2026-05-04 / PR #370
  • Updated last_updated to 2026-05-04
  • Updated inline metadata table at bottom of file

docs/planning/wip.md

  • Removed stale "In Progress" entry for UIGen v0.6.0 (that merged as PR #326 in May 2026)
  • Added to "Recently Completed": PRs #358, #360, #361, #363, #326 (content-api, UIGen v0.6.0)

docs/planning/roadmap.md

  • Added content-api and UIGen v0.6.0 entries to Kanban "Done" column
  • Added PRs #358, #360, #361, #363, #326, #370 to the "Completed" list
  • Added Phase 2 and Phase 3 API refactor items to Near Term Backend section

What Was Found Stale

Location Issue Status
docs/planning/wip.md In Progress UIGen v0.6.0 listed as open PR — merged #326 Fixed
docs/architecture/backend.md Project Structure Showed flat api/ with no core/, templates/, repositories/, services/, data/ Fixed
docs/planning/roadmap.md Kanban PRs #358, #363, #326, #360, #361, #370 not listed in Done Fixed
docs/planning/roadmap.md Completed PRs since #304 missing from Completed list Fixed

What Remains / Out of Scope

The following were intentionally not updated in this pass:

  1. docs/api/endpoints.md — Already up to date through PR #358/#362 (last_updated 2026-05-03). No new endpoints were added in #363 or #370 (both are annotations / structural refactor only, no new routes).

  2. docs/development/uigen.md — Already up to date through PR #358/#362 (last_updated 2026-05-03). UIGen v0.6.0 features were already reflected in PR #364's partial docs update.

  3. docs/architecture/backend.md Testing section — Four new test files exist on branch test/api-coverage-phase1 (commit 85e9990: test_portfolio_endpoints.py, test_db_endpoints.py, test_feature_flags.py, test_admin_endpoints.py) but that branch is NOT merged into this worktree's branch. Documentation of those tests should be added when that branch merges.

  4. Nav structure — Out of scope per task brief.

  5. API Phase 2–6 plan docs — docs/planning/plan-api-arjan-refactor.md was committed in PR #370 and is current. No changes needed.

  6. ADR for API refactor — The plan references considering an ADR for migration immutability policy (Phase 5.2). Not yet needed until Phase 5 begins.

Branch State

The branch has commits from this docs update session. Run markdownlint-cli2 "docs/**/*.md" before pushing if linting is required by pre-commit hooks.