docs: make replay/record/run substrate-aware, not --url-centric#48
Merged
Conversation
`--url` is web-only. Reframe the replay/record/run docs so the browser path is one first-class substrate among Windows/macOS/Linux/RDP/Citrix, selected via `--backend` (+ its target flag) or the deployment config's `backend` section, not via `--url` as the general case. - run-a-deployment: replay is substrate-aware; the bundled-demo path is one web example, not the definition; governed runs get their substrate from `backend` in deployment.yaml. - reference/cli: fix the record verb row, record + replay descriptions, and the `--url` "required" note (required only for `--backend web`). - reference/deployment-config: document `backend.kind` and per-substrate target fields (agent_url/macos_app/linux_app/rdp_host); mark url/headed web-only; extend the flag-override list. - demonstration-compiler / record-your-app / first-workflow: keep the web quickstart but present it as the web substrate with a backend pointer. - durable-runtime: resume rebuilds the backend via the same selector, not just backend.url. Pinned substrate-evidence copy and legal/compliance copy untouched; mkdocs --strict, pytest (64), and validate_docs all green. 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
1 participant
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.
Problem
docs.openadapt.aiframedreplay/record/runaround--urland "the bundled sample app," but--urlis web-only. The trigger, inguides/run-a-deployment.md: "replay is the demo-shaped command: with no--urlit serves the bundled sample app" presented--urlas THE way to target replay.Ground truth (verified against
openadapt-flowopenadapt_flow/__main__.py+deployment.pyonmain)replay/record/run/resumetake_add_backend_flags:--backend {web,windows,macos,linux,rdp}plus target flags--url(web),--agent-url(windows),--macos-app,--linux-app,--rdp-host(rdp/Citrix).--urlapplies only to--backend web; omit it and web replay serves the bundled MockMed demo.--backend <X>+ its target flag, not--url. Pixel-only remote desktop / Citrix =--backend rdp.deployment.yaml'sbackendsection via--config, not--url. Config field names confirmed inBackendConfig(kind,agent_url,macos_app,linux_app,rdp_host,rdp_window).Changes
Web stays one first-class substrate; the demo path is kept as one example, not the definition.
backendsection.--urlmarked required only for--backend web.backend.kind+ per-substrate target fields; markedurl/headedweb-only; extended the flag-override list.backend.url.Not touched
Pinned substrate-evidence copy (run counts, oracle results, commit hashes, PR numbers, Supported/scoped markers per
test_substrate_evidence_copy.py) and binding legal/compliance copy left intact.Gates
mkdocs build --strictcleanpytest tests/— 64 passedscripts/validate_docs.py— Validation passedNo em dashes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM