From 9684e996b16527be1ce9219b8a58147ade43e0d7 Mon Sep 17 00:00:00 2001 From: Richard Abrich Date: Wed, 19 Aug 2026 17:41:54 -0400 Subject: [PATCH] docs: publish the canonical launcher quickstart 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 --- profile/README.md | 15 +++++++-------- scripts/check_profile.py | 12 ++++++++++++ 2 files changed, 19 insertions(+), 8 deletions(-) diff --git a/profile/README.md b/profile/README.md index a32495c..ab7f629 100644 --- a/profile/README.md +++ b/profile/README.md @@ -25,16 +25,15 @@ the canonical current engine is ## Start Locally ```bash -pip install openadapt -openadapt flow demo-record --out rec -openadapt flow compile rec --out bundle --name mockmed-triage -openadapt flow certify bundle --policy permissive -openadapt flow replay bundle --run-dir run +python -m pip install --upgrade 'openadapt[browser]' +openadapt quickstart ``` -This runs the bundled MockMed example and writes a human-readable `REPORT.md`. -Use the [five-minute guide](https://docs.openadapt.ai/get-started/) to add lint, -policy certification, drift, repair, and deployment. +This runs the bundled MockMed lifecycle. It records, compiles, certifies, +replays, independently verifies the synthetic effect, and writes a +human-readable `REPORT.md`. Use the +[five-minute guide](https://docs.openadapt.ai/get-started/) to add lint, drift, +repair, and deployment. ## Evidence diff --git a/scripts/check_profile.py b/scripts/check_profile.py index b0770c6..e381441 100755 --- a/scripts/check_profile.py +++ b/scripts/check_profile.py @@ -123,6 +123,18 @@ def main() -> int: if marker not in profile_text: errors.append(f"profile/README.md is missing required marker: {marker}") + canonical_quickstart = ( + "python -m pip install --upgrade 'openadapt[browser]'", + "openadapt quickstart", + ) + for command in canonical_quickstart: + if command not in profile_text: + errors.append( + f"profile/README.md is missing canonical quickstart command: {command}" + ) + if "openadapt flow demo-record --out rec" in profile_text: + errors.append("profile/README.md publishes the superseded manual tutorial path") + profile_links = set(LINK_RE.findall(profile_text)) missing_links = sorted(REQUIRED_PROFILE_LINKS - profile_links) if missing_links: