Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 7 additions & 8 deletions profile/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
12 changes: 12 additions & 0 deletions scripts/check_profile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down