From 3b5e8c663f6ec6ffa39d6f7feab6d34f0deb7e6e Mon Sep 17 00:00:00 2001 From: abrichr Date: Sun, 2 Aug 2026 18:26:16 +0200 Subject: [PATCH] docs: align entry commands and substrate maturity across repo READMEs Adopt the canonical first-run path (pip install 'openadapt[browser]' + openadapt quickstart), keep engine-direct commands as explicit variants of the same loop, use the shared substrate-maturity table verbatim, name the tutorial fixture MockMed (a synthetic practice-management fixture) on first mention, and show the cmd.exe double-quoted install form. Co-Authored-By: Claude Fable 5 --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f6863e72..2371749aa 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,9 @@ 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: @@ -49,7 +52,8 @@ target application, API key, or operating-system automation permissions: 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 @@ -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