Skip to content

Commit 5bf3500

Browse files
authored
docs: restructure docs.openadapt.ai into Diátaxis sections (for review) (#240)
* docs(ia): Diataxis navigation and three Get started tracks (WIP) Signed-off-by: Richard Abrich <richard.abrich@mldsai.com> * docs(ia): rewrite home page; three-track contract; agents.txt and llms.txt follow the new IA Signed-off-by: Richard Abrich <richard.abrich@mldsai.com> * docs(ia): Try it footers, glossary admission entry, one hosted-retention description, section indexes Signed-off-by: Richard Abrich <richard.abrich@mldsai.com> * docs(ia): point tutorial links at the command-line track; Desktop permission warning up front Signed-off-by: Richard Abrich <richard.abrich@mldsai.com> * docs(cli): show what REPORT, report.json and receipt.json look like Adds a 'What these look like' section under the tutorial output table: the receipt.png from a real tutorial run (lossless WebP, 10 KB) and trimmed excerpts of that run's report.json and receipt.json. Signed-off-by: Richard Abrich <richard.abrich@mldsai.com> * docs(index): say which independent reads are strongest; don't overstate a UI read Signed-off-by: Richard Abrich <richard.abrich@mldsai.com> --------- Signed-off-by: Richard Abrich <richard.abrich@mldsai.com>
1 parent 16e38eb commit 5bf3500

42 files changed

Lines changed: 1034 additions & 541 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/agents.txt‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,37 @@ Run outcomes: https://docs.openadapt.ai/reference/run-outcomes/
1111

1212
## How to call
1313

14+
Walkthrough for agents: https://docs.openadapt.ai/get-started/agent-mcp/
15+
16+
```
17+
claude mcp add openadapt -- uvx --python 3.12 openadapt-agent serve
18+
```
19+
20+
That is the sandbox. To have the real engine drive the synthetic MockMed app:
21+
1422
```
15-
claude mcp add openadapt -- \
16-
uvx --from 'openadapt-agent[tutorial]' openadapt-agent \
17-
serve --allow-run
23+
claude mcp add openadapt -- uvx --python 3.12 --from 'openadapt-agent[tutorial]' openadapt-agent serve
1824
```
1925

26+
Your own compiled workflows: `openadapt-agent serve --mode production --bundles DIR --runs-dir RUNS`. `--allow-run` is the older form of `--mode production`.
27+
28+
The engine on its own:
29+
2030
```
2131
python -m pip install --upgrade openadapt
2232
openadapt flow tutorial
2333
openadapt quickstart --break-it
2434
```
2535

26-
`--allow-run` is an explicit opt-in. Never summarize halt as success.
36+
Never summarize halt as success.
2737

2838
## Outcome vocabulary
2939

30-
`VERIFIED` | `HALTED` | `RECONCILIATION_REQUIRED` | `REFUSED` | `TIMEOUT` | `ERROR`
40+
MCP `outcome`: `done` | `needs_review` | `not_sure_if_saved` | `did_not_run`, and `running` while a run is in progress. Branch on `outcome` and `safe_to_retry`.
41+
42+
Engine `transaction_outcome`: `VERIFIED` | `HALTED_BEFORE_EFFECT` | `RECONCILIATION_REQUIRED` | `REJECTED_POLICY` | `CANCELED` | `FAILED_PLATFORM` | `COMPLETED_UNVERIFIED` | `ROLLED_BACK`. Engine `execution_outcome`: `VERIFIED` | `COMPLETED_UNVERIFIED` | `HALTED` | `FAILED` | `ROLLED_BACK`.
3143

32-
`VERIFIED` means the independent check passed. Halt is not success. If delivery is uncertain after an action may have been dispatched, the outcome is `RECONCILIATION_REQUIRED`. Do not blindly retry.
44+
`VERIFIED` (`done`) means the declared result checks passed through a read independent of the acting screen. Halt is not success. If delivery is uncertain after an action may have been dispatched, the outcome is `RECONCILIATION_REQUIRED` (`not_sure_if_saved`). Do not retry it; a person checks the record.
3345

3446
Read `report.json` and the seal. `REPORT.md` is for humans.
3547

‎docs/assets/screenshots/PROVENANCE.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,3 +120,10 @@ seal-certificate-mobile.png
120120
OpenAdaptAI/openadapt-web `public/seals/certificate-mobile.png`, copied
121121
from the same worktree. SHA-256:
122122
7d2c83d1e178b4f42ab55f3ff7f4c9dc875f0ad13b6ee051a9c1ba0b8b278116.
123+
124+
tutorial-receipt.webp
125+
The receipt.png that `uvx --python 3.12 openadapt flow tutorial` wrote for a
126+
VERIFIED run of the synthetic MockMed tutorial (openadapt 1.17.0,
127+
2026-10-17), re-encoded as lossless WebP with `cwebp -lossless -z 9`.
128+
Unedited otherwise. Used on get-started/cli.md. SHA-256:
129+
7f9e55e7eb10499138b75d18bba004abb1b7d5a9826f348921e8f5eef4ab9e6a.
10.2 KB
Loading

‎docs/assets/visual-palette.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -392,6 +392,28 @@
392392
"share_percent": 1.5
393393
}
394394
]
395+
},
396+
"screenshots/tutorial-receipt.webp": {
397+
"source_repository": "OpenAdaptAI/openadapt-flow",
398+
"source_path": null,
399+
"note": "receipt.png written by `uvx --python 3.12 openadapt flow tutorial` (openadapt 1.17.0) on 2026-10-17, re-encoded as lossless WebP. Generated by the product, not captured from a page; the receipt renders on a dark ground.",
400+
"sha256": "7f9e55e7eb10499138b75d18bba004abb1b7d5a9826f348921e8f5eef4ab9e6a",
401+
"width": 620,
402+
"height": 566,
403+
"dominant_colors": [
404+
{
405+
"hex": "#101216",
406+
"share_percent": 86.8
407+
},
408+
{
409+
"hex": "#56cc84",
410+
"share_percent": 0.76
411+
},
412+
{
413+
"hex": "#0f1115",
414+
"share_percent": 0.7
415+
}
416+
]
395417
}
396418
}
397419
}

‎docs/commercial/subprocessors.md‎

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -54,28 +54,13 @@ failure signal (schema `openadapt.automation-failure-signal/v1`):
5454

5555
## Hosted retention and deletion
5656

57-
The hosted service applies a **versioned, explicitly configured retention
58-
policy**; there is no implicit retention duration. The policy names its
59-
version and sets explicit windows for recordings, reports, and run metadata
60-
(run metadata is never retained shorter than reports), plus a backup recovery
61-
window and a maximum restore-drill age.
62-
63-
Current behavior:
64-
65-
- **Scheduled deletion is fail-closed.** Destructive scheduled retention
66-
refuses to run without a recent receipt proving a complete database **and**
67-
private object storage restore into an isolated scratch environment.
68-
- **Legal holds pause eligible deletion** for the held organization.
69-
- **Tenant erasure is organization-scoped** and produces an append-only,
70-
PHI/PII-free receipt with identifiers, counts, and digests, never deleted
71-
payloads.
72-
- The public [readiness endpoint](https://app.openadapt.ai/api/health/ready)
73-
reports the configured retention component separately from the
74-
destructive-operation gate.
75-
76-
The concrete day windows are deployment configuration, reviewed with the
77-
policy version; request the current policy version and its windows directly
78-
rather than citing this page.
57+
The hosted service applies a versioned, explicitly configured retention policy
58+
with no implicit retention duration. Scheduled deletion is fail-closed until a
59+
complete restore drill has passed, legal holds pause deletion, and tenant
60+
erasure is organization-scoped with a PHI/PII-free receipt. The concrete day
61+
windows are deployment configuration: request the current policy version and
62+
its windows directly. The full description is in
63+
[Hosted retention, deletion, and recovery](../guides/security-and-data-handling.md#hosted-retention-deletion-and-recovery).
7964

8065
## Data-flow summary
8166

‎docs/concepts/capability-ladder.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,8 @@ browser can, in principle, retarget to a desktop or RDP backend by recompiling
5353
the same semantic transitions to whatever rung that surface supports, each
5454
satisfying the same contract. The [workflow-program IR](workflow-ir.md) is the
5555
schema that makes one meaning, many implementations, expressible.
56+
57+
## Try it
58+
59+
- [Record your own app](../guides/record-your-app.md): record with the structural evidence the ladder uses.
60+
- [Troubleshooting over-halting](../guides/troubleshooting.md#it-halts-too-much-over-halting-on-citrix-pixel-only): when a pixel-only surface halts too often.

‎docs/concepts/demonstration-compiler.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,8 @@ cannot express conditionals, loops, or the failure branch it never took. The
9494
[workflow-program IR](workflow-ir.md) and
9595
[multi-trace induction](multi-trace-induction.md) are how OpenAdapt recovers the
9696
intended program from more than one trace.
97+
98+
## Try it
99+
100+
- [Get started on the command line](../get-started/cli.md): record, compile, and verify the bundled tutorial.
101+
- [Record your own app](../guides/record-your-app.md): compile a demonstration of your own web app.

‎docs/concepts/deployment-matrix.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,3 +199,8 @@ pixels before delivery.
199199
Review [Qualification evidence](../get-started/what-works-today.md) and the engine's
200200
[published limits](https://github.com/OpenAdaptAI/openadapt-flow/blob/main/docs/LIMITS.md)
201201
before selecting a workflow.
202+
203+
## Try it
204+
205+
- [Deploy on-prem](../guides/deploy-on-prem.md): keep runtime data in your network.
206+
- [The hosted option](../guides/hosted.md): the managed browser subscription.

‎docs/concepts/durable-runtime.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,3 +113,7 @@ engine re-verifies live state, is the
113113
See the [Run a deployment](../guides/run-a-deployment.md) guide for a worked
114114
durable run, and the [CLI reference](../reference/cli.md#resume) for `resume` /
115115
`approve` exit codes.
116+
117+
## Try it
118+
119+
- [Durable runs pause and resume](../guides/run-a-deployment.md#durable-runs-pause-and-resume): a worked durable run.

‎docs/concepts/effect-verification.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,8 @@ success banner must halt and the store must stay unchanged. `qualify propose`
116116
and `qualify accept` run the proposed oracle against the same kind of fault on
117117
their own. See [The Seal](../commercial/seal.md). A tier-2 read is also the
118118
only thing that earns a training reward: [Seal as an RL reward](../commercial/seal-reward.md).
119+
120+
## Try it
121+
122+
- [Make the tutorial stop on purpose](../get-started/cli.md#make-it-stop-on-purpose): watch a refuted write halt.
123+
- [Verify writes against the system of record](../guides/run-a-deployment.md#verify-writes-against-the-system-of-record): wire a verifier in a deployment.

0 commit comments

Comments
 (0)