docs: refresh README (accurate positioning + demonstration compiler prominence)#1007
Merged
Conversation
…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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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)
pip install openadapt-flow, v0.3.x)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 intendeddocs/readme-refreshcollides with the existing remotedocsbranch — a ref directory/file conflict).🤖 Generated with Claude Code
https://claude.ai/code/session_01CKrVJJy5jWVCkXAqgUqtqZ