docs: make downloadable workflow migration guide a genuine agent task spec#1086
Open
bets-margulies-vapi wants to merge 1 commit into
Open
docs: make downloadable workflow migration guide a genuine agent task spec#1086bets-margulies-vapi wants to merge 1 commit into
bets-margulies-vapi wants to merge 1 commit into
Conversation
The merged .md was the human guide reflowed into plain markdown. Rewrite it as an agent-oriented migration spec: task framing, the input Workflow schema, output Squad/assistant/handoff-tool schemas, a deterministic transform procedure, a full worked input->output example grounded in the real API shapes, variable-extraction rules, when-to-ask guidance, and a validation checklist. Update the page blurb to match. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KfSaT4cFb2DggCYTctrzEq
dhruva-vapi
approved these changes
Jun 26, 2026
Contributor
|
🌿 Preview your docs: https://vapi-preview-0a308af6-4c02-4805-a4eb-fe2d5bc29e23.docs.buildwithfern.com |
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
3 participants
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
Follow-up to #1081. The downloadable
static/workflow-migration-guide.mdthat shipped in #1081 was really the human guide reflowed into plain markdown — readable by an LLM, but not tailored for one. This rewrites it as an actual agent migration spec.Why
An agent doing the migration needs the transformation contract, not prose. The previous file described steps in words ("add a handoff tool", "configure variable extraction") but never gave the input/output JSON shapes or a worked transform, so a model couldn't reliably emit valid output.
Changes
static/workflow-migration-guide.mdrewritten as a task spec:extractVariables,edges,isGlobal, …)squads/handoff.mdx,squads.mdx, and the clinic-triage example — no invented fields)variableExtractionPlanwhen a var crosses an assistant boundary; branch-selector vars need none)workflows/legacy-migration.mdx: updated the download blurb to describe it as a task spec (schemas + worked example), and to point the model atGET /workflow/{id}as the input.Note
The worked example uses a fictional "Acme Dental" workflow because it exercises a conditional branch + a cross-boundary variable cleanly. Happy to swap it for a real example doc if preferred.
🤖 Generated with Claude Code
https://claude.ai/code/session_01KfSaT4cFb2DggCYTctrzEq
Generated by Claude Code