Skip to content

docs: make controlled-alpha onboarding executable - #62

Merged
wms2537 merged 1 commit into
mainfrom
codex/issue-61-onboarding
Jul 22, 2026
Merged

docs: make controlled-alpha onboarding executable#62
wms2537 merged 1 commit into
mainfrom
codex/issue-61-onboarding

Conversation

@wms2537

@wms2537 wms2537 commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add a Docker-only public-image quickstart with a safe loopback demo profile
  • add executable first-run and approval/recovery clients
  • add operational tutorials for first Run, worker-restart recovery, and the Kertas public contract
  • make internal Markdown links and the documented Compose flow part of the controlled-alpha CI gate
  • update the README, Usage Guide, and release runbook for the now-public alpha image

Why

The controlled-alpha image was publicly pullable, but a newcomer still had to invent PostgreSQL wiring, runtime configuration, the first API call, and the recovery exercise. Existing scenario articles demonstrate use cases but do not provide an executable onboarding path.

Impact

A user with Docker can now complete a deterministic durable Run without local Node.js, BytePlus credentials, or model spend. The same Compose path is exercised against each release candidate in CI. Kertas integration remains limited to the versioned public API and event protocol.

Verification

  • TDD onboarding contract: 8/8
  • internal documentation links: 23 Markdown files
  • live public-image quickstart: first durable Run PASS
  • live approval recovery across worker restart: PASS
  • TypeScript typecheck: PASS
  • full suite: 65 files / 483 tests
  • exact-commit controlled-alpha gate: PASS
  • git diff check: PASS

Fixes #61

@wms2537
wms2537 marked this pull request as ready for review July 22, 2026 16:24
@wms2537
wms2537 merged commit 7ba150a into main Jul 22, 2026
1 check passed
@wms2537
wms2537 deleted the codex/issue-61-onboarding branch July 22, 2026 16:25
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.

P1: Make public alpha onboarding executable and reader-tested

1 participant