docs(readme): add real visualize graph, loop/halt diagrams, and run screenshots#1040
Merged
Conversation
…creenshots Add inline visuals to the launcher README while preserving the two-path (local-first / cloud-optional) structure. - Embed the ACTUAL program graph that `openadapt flow visualize bundle --format mermaid` emits for the bundled MockMed workflow (11 steps, armed identity gate on the opened record, irreversible+halt on the write). It is real tool output, not hand-drawn, generated from a demo-record -> compile -> visualize run on openadapt-flow. - Add a compact record -> compile -> replay loop diagram (Mermaid) that also shows the resolve-or-halt decision. - Reuse real desktop-app (Experimental) screenshots of the same MockMed workflow: a verified 11/11, $0.000 replay and a safe halt when a step cannot be verified. Optimized/resized (1400px, ~135-150KB each) under media/. - Link the "illustrated REPORT.md" mentions to real committed example run reports in openadapt-flow (baseline + theme-drift), via absolute github.com URLs so they resolve from PyPI too. PyPI does not render Mermaid, so every Mermaid block carries a one-line text summary, and images use absolute raw.githubusercontent.com URLs so they resolve in the PyPI long description after merge. No em dashes added; net em-dash count unchanged from origin/main. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM
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
Adds inline visuals to the launcher README, keeping the existing two-path (local-first / cloud-optional) structure intact.
1. Real
visualizeprogram graph (not hand-drawn)Embeds the actual Mermaid graph that
openadapt flow visualizeemits for the bundled MockMed workflow, right wherevisualizeis described in Path 1. Generated from real tool output onopenadapt-flow:(The workspace
openadapt-flowHEAD carriesvisualize/for-each; the currently-published 1.19.0 wheel predates them, so the graph was produced from source.) The graph shows the 11 ordered steps, the armed identity gate onclick 'Open', and theSave Encounterwrite marked irreversible and as the run's single halt point. It is copied verbatim from the tool, small enough (12 nodes) to embed whole with no trimming.2. Record -> compile -> replay loop diagram (Mermaid)
A compact
flowchart LRthat also encodes the resolve-or-halt decision (halt-don't-guess), added at the end of "Why a compiler".3. Real product screenshots (reused, not invented)
Two real Experimental desktop-app screenshots of the same MockMed workflow, optimized/resized to 1400px (~135-150 KB each) under
media/:desktop-replay-verified.png- a clean 11/11 deterministic replay at$0.000(no model calls on a healthy run).desktop-replay-halted.png- a run halting safely when a typed value cannot be verified.4. Link the illustrated
REPORT.mdThe "illustrated
REPORT.md" mentions now link to real committed example run reports inopenadapt-flow(baseline + theme-drift), via absolutegithub.comURLs.Honest + PyPI-safe
raw.githubusercontent.com/OpenAdaptAI/OpenAdapt/main/...URLs so they resolve in the PyPI long description after merge (they will 404 on the PR preview until merged tomain, which is expected).origin/main. No content-lint/CI covers the README in this repo (only a docs-publisher guard, untouched).🤖 Generated with Claude Code
https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM