Skip to content

docs: publish the canonical launcher quickstart - #12

Merged
abrichr merged 1 commit into
mainfrom
codex/canonical-quickstart-only
Aug 19, 2026
Merged

docs: publish the canonical launcher quickstart#12
abrichr merged 1 commit into
mainfrom
codex/canonical-quickstart-only

Conversation

@abrichr

@abrichr abrichr commented Aug 19, 2026

Copy link
Copy Markdown
Member

What changed

  • replace the stale pip install openadapt + four-command openadapt flow ... block in profile/README.md with the supported single-command path
  • add a scripts/check_profile.py contract that pins the canonical quickstart commands and refuses a regression to the superseded manual sequence

Why

The published sequence cannot run as written. The base launcher install resolves openadapt-flow[hosted]; Playwright ships only through the openadapt[browser] extra, so openadapt flow demo-record fails on a clean base install. openadapt quickstart (openadapt/cli.py) is the supported single command and runs the same bundled MockMed lifecycle.

The prose states only what the tutorial actually does. openadapt_flow.tutorial.run_tutorial stages are record, compile, certify, run under the standard profile with independent effect verification, and receipt. It does not lint, so lint stays in the follow-on guide sentence rather than in the description of the command.

Scope

This is the stale-fact half of draft #10, taken alone and rebased on current main.

Deliberately not included, and still held on codex/capture-beta-lifecycle:

  • the openadapt-capture Experimental-to-Beta relabel (REPOSITORY_LIFECYCLE.md, repository-lifecycle.yml, the profile "Native capture" row, and the check_profile.py expected lifecycle)
  • the new ## Production Qualification profile section and its required-marker contract

No lifecycle label changes here. Capture stays Experimental. Every Production membership and admission list stays empty. No production-readiness claim is published.

Validation

  • python3 scripts/check_profile.py — canonical product truth and 36 Markdown links
  • python3 -m unittest discover -s tests -p 'test_*.py' — 40 passed
  • git diff --check — clean

🤖 Generated with Claude Code

The org profile told readers to run `pip install openadapt` and then
`openadapt flow demo-record`. The base launcher install no longer carries
Playwright -- the browser dependency ships only in the `openadapt[browser]`
extra -- so the published sequence cannot run as written.

Replace it with the supported single-command path, `openadapt quickstart`,
which runs the bundled MockMed lifecycle end to end (record, compile,
certify, replay, independent effect verification, REPORT.md). Add a
validator contract so the profile cannot regress to the broken sequence.

This is a stale-fact correction only. It changes no lifecycle label and
makes no production-readiness claim.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@abrichr
abrichr merged commit d60445b into main Aug 19, 2026
2 checks passed
@abrichr
abrichr deleted the codex/canonical-quickstart-only branch August 19, 2026 21:43
abrichr added a commit that referenced this pull request Aug 19, 2026
HOLD -- do not merge until the acceptance evidence exists.

This is the visible maturity-label change for Capture, isolated so it can
ship as one action under the one-visible-change-at-the-end rule.

The stale-fact half of this branch (the canonical launcher quickstart)
merged separately in #12 and is already on main.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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