Skip to content

docs: operator path for compose and ProcessContract - #177

Merged
abrichr merged 2 commits into
mainfrom
docs/process-contract-and-compose
Aug 29, 2026
Merged

docs: operator path for compose and ProcessContract#177
abrichr merged 2 commits into
mainfrom
docs/process-contract-and-compose

Conversation

@abrichr

@abrichr abrichr commented Aug 29, 2026

Copy link
Copy Markdown
Member

An operator who already recorded one app needs the next step when the task crosses a second surface. Flow origin/main already has openadapt-flow compose. This change is the operator documentation for that sequencer and for the ProcessContract parent that sits on top of admitted capabilities.

docs/guides/compose-multi-application.md is the one path: record one program per surface, compose the compiled recordings, qualify and admit each child, then process for a ProcessContract parent (openadapt.process-contract/v0). docs/concepts/process-contract.md is the short receipt and handoff note. The CLI verbs table, visualize, get-started, and Execute pick up the matching cross-links.

Compose sequences compiled recordings into composition.json. Process points at independently admitted capabilities. It doesn't copy recordings and it doesn't become a ProgramGraph. Pointing it at composition.json is refused. Each process child runs through Execute with that child's envelope. Replay of either parent is refused.

visualize on a process parent shows admitted children, handoff edges, and a terminal labeled End of declared steps. A compiled bundle still has its own program graph. Don't merge those pictures.

No Production, SLA, or Citrix claim.

Opened by an agent session, not the founder.

What a reviewer must check

  • The compose flags match Flow origin/main: --child NAME=PATH, --handoff FROM.source=TO.target, --after, --allow-halt, --out.
  • Process children are admission_ids, not bundle paths.
  • Get-started stays a short pointer, not a second guide.
  • Terminal label is End of declared steps, not Success.

Test plan

  • uv run python scripts/validate_docs.py
  • uv run mkdocs build --strict
  • Nav: guide under Build near visualize; concept near qualification

Record one program per surface, sequence compiled recordings with compose,
then after admission author a process parent. Visualize keeps the parent as
children plus handoff edges, ending at End of declared steps.
The live Flow authoring flags are NAME=BUNDLE plus a per-child envelope
file. An admission UUID is not a --child value.

Opened and committed by an agent session, not the founder.
@abrichr
abrichr merged commit 115fcf7 into main Aug 29, 2026
8 checks passed
@abrichr
abrichr deleted the docs/process-contract-and-compose branch August 29, 2026 15:17
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