From 714df74d6e09330f6f57a26ddb7098c6aff36cbf Mon Sep 17 00:00:00 2001 From: abrichr Date: Tue, 21 Jul 2026 01:33:55 -0400 Subject: [PATCH] docs(readme): add SVG masthead hero and fix mermaid loop control overlap Job 1 (control overlap): GitHub overlays pan/zoom controls along the bottom edge of every rendered mermaid block. In the top-of-README loop diagram the "Halt with a report" node landed in the bottom-right corner (measured at x=0.94W, y=0.71H of the rendered viewBox) and was hidden under the controls. Both outcomes now converge into a single mid-height "Illustrated run report" node, which pushes the far-right column to the vertical center and moves both terminal nodes inboard, leaving both bottom corners empty. The convergence is honest: every replay already writes an illustrated REPORT.md. The second (visualize) diagram is a single centered column ending in a bottom-center Success node, so its corners are already clear and it is unchanged. Job 2 (masthead): add media/openadapt-hero.svg, a hand-authored, self-contained SVG hero (17 KB, no raster) telling the whole governed-demonstration-compiler story at a glance: record -> compile to a deterministic program -> deterministic replay with no model calls on the healthy path -> resolution ladder (structural, template, OCR, geometry; grounding model optional and never on the hot path) -> armed identity gates -> independent out-of-band effect verification -> halt with a report for a human or an AI. Footer bands show substrate and surface coverage with honest maturity labels (Browser Beta; Windows/macOS/RDP scoped; Linux research; Citrix/VDI exploratory; Cloud Beta browser; Desktop experimental). Palette aligns with openadapt.ai (paper/ink + accent green). The SVG is theme-aware via an in-document prefers-color-scheme media query with a legible light-paper default, so it reads on both GitHub light and dark and on PyPI. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM --- README.md | 12 +++- media/openadapt-hero.svg | 117 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 128 insertions(+), 1 deletion(-) create mode 100644 media/openadapt-hero.svg diff --git a/README.md b/README.md index da711bdb4..f2b6a7130 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ # OpenAdapt: Launcher for the OpenAdapt Flow Compiler +

+ + OpenAdapt is the governed demonstration compiler for GUI workflows. Record a demonstration once, compile it to a deterministic program, and replay it locally with no model calls on the healthy path. When the UI drifts, a resolution ladder (structural, template, OCR, geometry, with an optional grounding model that is never on the hot path) re-resolves the target; armed identity gates and independent out-of-band effect verification guard writes; and the run halts with a report for a human or an AI instead of guessing. It runs across browser (Beta), Windows, macOS and RDP (scoped), Linux (research) and Citrix/VDI (exploratory), surfaced via CLI, desktop app, tray, Cloud (Beta, browser) and emitted MCP servers and Agent Skills. + +

+ [![Build Status](https://github.com/OpenAdaptAI/OpenAdapt/actions/workflows/main.yml/badge.svg)](https://github.com/OpenAdaptAI/OpenAdapt/actions/workflows/main.yml) [![PyPI version](https://img.shields.io/pypi/v/openadapt.svg)](https://pypi.org/project/openadapt/) [![Downloads](https://img.shields.io/pypi/dm/openadapt.svg)](https://pypi.org/project/openadapt/) @@ -57,15 +63,19 @@ flowchart LR R -->|UI drifted| L{"Resolution ladder
re-resolves the target?"} L -->|resolved| V L -->|no confident match| H["Halt with a report"] + V --> P["Illustrated run report"] + H --> P classDef halt stroke:#b21f2d,stroke-width:2px; + classDef ok stroke:#3e6b4f,stroke-width:2px; class H halt; + class V ok; ``` *Text summary (PyPI does not render Mermaid): demonstrate once, compile to a local program, then replay it deterministically with no model calls. If the UI matches, the write is verified; if it drifted, the resolution ladder re-resolves the target, and if it cannot establish a confident match the run halts with a -report instead of guessing.* +report instead of guessing. Either way, every run writes an illustrated report.* --- diff --git a/media/openadapt-hero.svg b/media/openadapt-hero.svg new file mode 100644 index 000000000..94964ea4c --- /dev/null +++ b/media/openadapt-hero.svg @@ -0,0 +1,117 @@ + + + + + + + + + + + + + + + + + +OpenAdapt +The governed demonstration compiler for GUI workflows + + +Healthy runs make no model calls + + + +Record a demo +once, on the real UI + + +Compile to a program +deterministic IR bundle + + +Deterministic replay +0 model calls, local, ms + + +Verified write +postconditions pass + + +Resolution ladder +structural / template +OCR / geometry +grounding model optional + + +Armed identity gate +refuse a low-confidence match + + +Effect verification +out-of-band record oracle + + +Halt, don't guess +report for a human or an AI + + + + + +on UI drift + + + + + +re-resolved +Deterministic on the healthy path · a grounding model is optional and never on the hot path · halt when identity or effect cannot be verified + +RUNS ACROSS + +Browser + +BETA + +Windows + +SCOPED + +macOS + +SCOPED + +Linux + +RESEARCH + +RDP + +SCOPED + +Citrix / VDI + +EXPLORATORY +SURFACED VIA + +CLI + +Desktop app + +EXPERIMENTAL + +Tray + +Cloud + +BETA BROWSER + +MCP servers + +Agent Skills + \ No newline at end of file