Skip to content

docs: align entry commands and substrate maturity across repo READMEs #1082

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abrichr merged 2 commits into from
Aug 2, 2026
+14 −1
Merged

docs: align entry commands and substrate maturity across repo READMEs #1082

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b5e8c6
docs: align entry commands and substrate maturity across repo READMEs
abrichr Aug 2, 2026
e57301d
Merge branch 'main' into docs-readme-alignment
abrichr Aug 2, 2026
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: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,18 @@ bundled tutorial:
python -m pip install --upgrade 'openadapt[browser]'
```

On Windows `cmd.exe`, use double quotes:
`python -m pip install --upgrade "openadapt[browser]"`.

Run the complete bundled tutorial with one command. It needs no account,
target application, API key, or operating-system automation permissions:

```bash
openadapt quickstart
```

The tutorial records and compiles a synthetic task, certifies it with the
The tutorial records and compiles a task in MockMed (a synthetic
practice-management fixture), certifies it with the
shipped clinical-write policy, and runs it under the Standard profile. A
separate read-only API confirms the saved record outside the screen that
performed the write. The healthy run returns `VERIFIED` with no model or Cloud
Expand Down Expand Up @@ -152,6 +156,15 @@ Every workflow is qualified against its exact application, version,
environment, identity contract, and effect verifier rather than inheriting a
blanket platform claim.

Substrate maturity, stated the same way across the OpenAdapt repositories:

| Substrate | Maturity |
| --- | --- |
| Browser (web) | Beta; available in production today through the managed browser product |
| Native desktop (Windows, macOS, Linux) | Available for customer-controlled execution; qualification evidence is task- and environment-specific |
| Remote display (RDP) | Available for customer-controlled execution; qualification evidence is task- and environment-specific |
| Citrix / VDI | Available for customer-controlled execution; real-environment ICA/HDX qualification is deployment-specific |

See the [substrate model](https://docs.openadapt.ai/concepts/substrate-model/),
[qualification evidence](https://docs.openadapt.ai/get-started/what-works-today/),
and [CLI reference](https://docs.openadapt.ai/reference/cli/) for the full
Expand Down