Skip to content

docs: refresh README (accurate positioning + demonstration compiler prominence)#1007

Merged
abrichr merged 1 commit into
mainfrom
docs-readme-refresh
Jul 13, 2026
Merged

docs: refresh README (accurate positioning + demonstration compiler prominence)#1007
abrichr merged 1 commit into
mainfrom
docs-readme-refresh

Conversation

@abrichr

@abrichr abrichr commented Jul 13, 2026

Copy link
Copy Markdown
Member

What

Refreshes the meta-package README so the top-of-file positioning and the Demonstration Compiler section reflect what the ecosystem actually ships now, without adding any capability claims that aren't true.

Changes (README.md only)

  • Top positioning: the one-line summary now reflects that OpenAdapt compiles a recorded workflow into a deterministic replay (openadapt-flow) in addition to conditioning/training/evaluating agents, and states the modular optional-extras design as a strength (base install is just the CLI).
  • Demonstration Compiler section (added by feat: expose openadapt-flow as the [flow] extra (demonstration compiler under the core brand) #1006) strengthened:
    • notes the standalone PyPI package (pip install openadapt-flow, v0.3.x)
    • sharpens the identity halt into a concrete wrong-record check that refuses a low-confidence match rather than click the wrong target
    • states backend status honestly: reference browser backend shipped (runs in CI, no OS permissions); desktop and RDP backends are adapters in progress, not production paths
    • mentions Skill / MCP emit
    • adds the OpenEMR field result (20/20 compiled vs 10/10 agent, ~half median latency, ~$0.55/run agent vs zero model calls compiled) with its caveats: small sample, shared daily-resetting public demo, not CI-reproducible; CI-reproducible control + adversarial safety measurements published alongside.

Honesty

No new capability claims beyond what openadapt-flow ships and documents. Every metric traces to openadapt-flow's own README/benchmark docs, and every caveat is preserved. Diff is 19 insertions / 4 deletions.

Branch is docs-readme-refresh (the intended docs/readme-refresh collides with the existing remote docs branch — a ref directory/file conflict).

🤖 Generated with Claude Code

https://claude.ai/code/session_01CKrVJJy5jWVCkXAqgUqtqZ

…rominence)

Sharpen the top-of-README positioning to reflect that OpenAdapt now
compiles a demonstration into a deterministic replay (openadapt-flow),
in addition to conditioning/training/evaluating agents, and state the
modular optional-extras design as a strength.

Strengthen the Demonstration Compiler section: note the standalone PyPI
package and v0.3.x, sharpen the wrong-record identity halt, state the
backend status honestly (browser shipped; desktop/RDP adapters in
progress), mention Skill/MCP emit, and add the OpenEMR field result with
its small-sample, not-CI-reproducible caveats.

No new capability claims beyond what openadapt-flow ships and documents.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CKrVJJy5jWVCkXAqgUqtqZ
@abrichr abrichr merged commit b524907 into main Jul 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant