Skip to content

docs: canonical glossary + execution-model diagrams#193

Merged
drewstone merged 1 commit into
mainfrom
docs/glossary-execution-model
Jun 8, 2026
Merged

docs: canonical glossary + execution-model diagrams#193
drewstone merged 1 commit into
mainfrom
docs/glossary-execution-model

Conversation

@drewstone
Copy link
Copy Markdown
Contributor

Adds the two docs written during the executor/driver unification, on top of current main (0.46.0). Docs-only.

  • docs/glossary.md — one canonical definition per term, grounded to file:line, with drifted synonyms flagged: iteration / round / rollout (≠ the driver↔worker round) / attempt; driver / worker / Executor / SandboxClient; TopologyMove; Budget / Spend / the conserved pool; Agent.act + the coordination MCP ("Scope-as-MCP").
  • docs/execution-model.md — the four diagrams: the unified Executor port (router/bridge/cli/sandbox/BYO) + two engines, driver vs worker, who gets which tools/MCPs (driver = operator toolbox, worker = artifact tools, analyst = read_trace only), and the spawn mechanics (reserve→resolve→run→reconcile).
  • Both indexed in docs/README.md.

Anchors verified against current main; tsc clean.

- glossary.md: one definition per term (iteration/round/rollout/attempt,
  driver/worker/executor, TopologyMove, budget/spend, Agent.act + the
  coordination MCP / Scope-as-MCP), grounded to file:line; drifted synonyms
  flagged (rollout != the driver-worker round).
- execution-model.md: the four diagrams — the unified Executor port + two
  engines, driver vs worker, who gets which tools/MCPs, the spawn mechanics.
- index both in docs/README.md.
@tangletools
Copy link
Copy Markdown
Contributor

✅ No Blockers — 3b24cd0a

Readiness 89/100 · Confidence 75/100 · 3 findings (3 low)

deepseek glm aggregate
Readiness 89 92 89
Confidence 75 75 75
Correctness 89 92 89
Security 89 92 89
Testing 89 92 89
Architecture 89 92 89

Full multi-shot audit completed 3/3 planned shots over 3 changed files. Global verifier still owns final merge decision. | Full multi-shot audit completed 3/3 planned shots over 3 changed files. Global verifier still owns final merge decision.

🟡 LOW Inconsistent file path for coordination.ts reference — docs/execution-model.md

Line 95 references '(mcp/tools/coordination.ts)' but the actual path from project root is 'src/mcp/tools/coordination.ts'. All other code references in the doc use src-relative paths like 'supervise/types.ts', 'supervise/runtime.ts', 'inline-sandbox-client', 'run-loop.ts'. Either use 'src/mcp/tools/coordination.ts' for consistency or adopt a uniform convention.

🟡 LOW Inconsistent anchor base path: bench/src/experiment.ts vs everything else — docs/glossary.md

Lines 14, 27, 36-37: 'Arm', 'Steer', 'Attempt', and 'Analyst' anchors reference bench/src/experiment.ts, while all other anchors use files under src/runtime/. The glossary doesn't indicate this path is in a different directory tree. Readers may look for experiment.ts under src/runtime/ and not find it. Consider qualifying as 'bench/src/experiment.ts' or adding a note that experiment types live in the bench package.

🟡 LOW Short file paths are ambiguous without directory context — docs/glossary.md

Multiple anchors use bare filenames like 'types.ts', 'driver.ts' that resolve to different files across the repo (e.g., src/runtime/types.ts vs src/supervise/types.ts vs bench/src/benchmarks/types.ts). The glossary's 'Anchor' column relies on CLAUDE.md conventions for disambiguation rather than being self-documenting. Consider prefixing with the source-directory root (e.g., 'runtime/types.ts:104') for unambiguous resolution.


tangletools · 2026-06-07T22:06:33Z · trace

Copy link
Copy Markdown
Contributor

@tangletools tangletools left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Approved — 3 non-blocking findings — 3b24cd0a

Full multi-shot audit completed 3/3 planned shots over 3 changed files. Global verifier still owns final merge decision. | Full multi-shot audit completed 3/3 planned shots over 3 changed files. Global verifier still owns final merge decision.

Full immutable report for this review: trace

Summary comment for this run: full summary


tangletools · 2026-06-07T22:06:33Z · immutable trace

@drewstone drewstone merged commit 89fe240 into main Jun 8, 2026
1 check 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.

2 participants