Document deterministic workflows, step contracts, and org-defined artifact kinds - #17
Open
pdtnelson wants to merge 1 commit into
Open
Document deterministic workflows, step contracts, and org-defined artifact kinds#17pdtnelson wants to merge 1 commit into
pdtnelson wants to merge 1 commit into
Conversation
…ifact kinds Replaces every reference to the deleted LLM workflow-runner and its strict-sequential execution model with the deterministic step driver's actual behavior: steps become eligible once their dependencies settle, independent steps can run concurrently, and a workflow's description is documentation rather than an instruction. - agents/writing-an-agent.mdx: new frontmatter surface (produces, consumes with mode/group-by, mutates-worktree) and inline kind registration; removed the deleted sequential-spawns key - workflows/agent-chain.mdx, workflows/overview.mdx, workflows/create-a-workflow.mdx, quickstart.mdx: corrected the strict-sequential execution claim and the description-as-instruction claim against the shipped step driver - workflows/running.mdx: added the skipped step status, its reason, and the invocation-count badge - workflows/artifacts.mdx: org-defined kinds are real; documented the exact-match schema evolution rule - agents/library.mdx: removed the workflow-runner section; excluded code-reviewer and security-analyzer (no durable output / superseded, respectively — not real functions for a customer to rely on); repositioned patch-generator as its own step with a migration note for the removed generatePatches flag - agents/tool-reference.mdx: documented emit_artifact, list_artifacts, get_artifact (previously undocumented) - agents/how-agents-work.mdx, agents/overview.mdx: removed remaining workflow-runner/orchestrator-as-LLM-decision-maker language Verified against the merged ENG-2193 train (agent-core #93, SAS #77, CAS #160, console-web #124 — all merged to main) rather than the planning docs' aspirational language; several claims (task composition still includes the workflow description as context, not as removed entirely) were corrected against the actual step-driver code. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
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.
Summary
Updates the customer-facing docs for the ENG-2193 merge train (deterministic workflow
execution, agent frontmatter contracts, and org-defined artifact kinds) — filed as
ENG-2210 ("[docs] Update customer-facing docs for deterministic workflows, step
contracts, and org-defined kinds").
The prior docs described an LLM workflow-runner that executed steps strictly in
sequence, composed each step's briefing from the workflow's description, and had no
authoring surface for step contracts or customer-defined artifact kinds. All three are
gone or changed with the ENG-2193 train, which is now fully merged to
mainin all fourrepos it touches (agent-core #93, sandbox-agent-server #77, cloud-agent-service #160,
console-web #124).
What changed
agents/writing-an-agent.mdx— new frontmatter surface:produces(a may, nevera must),
consumes(mode: each|all, thegroup-byvocabulary usingpatch-generator's real shipped frontmatter as the example),mutates-worktree, andinline kind registration with the exact-match evolution rule. Removed
sequential-spawns(deleted outright, never customer-facing to begin with — no migration note).
workflows/agent-chain.mdx,workflows/overview.mdx,workflows/create-a-workflow.mdx,quickstart.mdx— corrected the "steps run strictly in sequence" and"the workflow description shapes every step's briefing" claims against the shipped
step driver: steps run once their actual dependencies settle, independent steps can
run concurrently, and the description is documentation shown to your team, not an
instruction.
workflows/running.mdx— added theSkippedstep status, its reason string, andthe invocation-count badge for fan-out steps.
workflows/artifacts.mdx— org-defined artifact kinds are documented as real(previously described as "where this is heading, not a set of features to build
against right now").
agents/library.mdx— removed the workflow-runner section; excludedcode-reviewerandsecurity-analyzerfrom the documented fleet (no durable output /already designated for retirement, respectively — not real functions for a customer to
rely on); repositioned
patch-generatoras its own chainable step with a migrationnote for the removed
generatePatchesflag.agents/tool-reference.mdx— documentedemit_artifact,list_artifacts,get_artifact(previously undocumented, despite being the entire mechanism behindorg-defined kinds).
agents/how-agents-work.mdx,agents/overview.mdx— removed remainingorchestrator-as-LLM-decision-maker language.
Verification
Every behavioral claim was checked against the actual merged code (agent-core's
schemas.ts, cloud-agent-service'skind-policy.ts/canonical-form.ts, sandbox-agent-server'sstep-driver.ts, console-web's step-row rendering diff) rather than the planning docs'language. One correction that came out of that: a workflow's description still rides
along as context on every step's composed task — it wasn't removed outright, just no
longer used to compose custom per-step instructions. The docs say that precisely.
A dedicated review pass confirmed no page names an internal service, storage shape,
internal API/event, or mechanism — every behavior is stated as the user-observable
contract.
Full inventory, fleet-audit reasoning, and open items are tracked on the ENG-2210 ticket.
🤖 Generated with Claude Code