Skip to content

docs(api): guide for building and running workflows with the API - #9901

Merged
waleedlatif1 merged 4 commits into
stagingfrom
docs/agent-authoring-guide
Nov 11, 2026
Merged

docs(api): guide for building and running workflows with the API#9901
waleedlatif1 merged 4 commits into
stagingfrom
docs/agent-authoring-guide

Conversation

@waleedlatif1

@waleedlatif1 waleedlatif1 commented Nov 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

  • Add an API guide that walks through building, dry-running, applying, testing, deploying, running, debugging, and resuming a workflow, with curl and sim CLI examples side by side and the Sim MCP equivalent. Linked both ways with the CLI workflows page (back-link added at its generator source).
  • Point coding agents at the existing Sim skills for the step-by-step loop instead of adding a second, overlapping skill to the MCP plugin.
  • X-Run-Id is documented as a one-shot claim (reuse returns 409 RUN_ID_CONFLICT), matching the contract.

Test plan

  • bun scripts/compile-content.ts in apps/docs (all pages compile, internal links valid)
  • bun run check:cli-docs
  • Review the rendered page at /api-reference/build-and-run-workflows

@vercel

vercel Bot commented Nov 11, 2026 •
edited
Loading

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Nov 11, 2026 10:08pm UTC

Request Review

cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed Nov 11, 2026
View reviewed changes

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 7 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Turn on auto-fix | Re-trigger cubic

@greptile-apps

greptile-apps Bot commented Nov 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge.

Summary

Adds an API guide for building, testing, deploying, running, debugging, and resuming workflows, with matching CLI examples and MCP guidance.

  • Developers can follow one guide from block discovery to an applied workflow draft.
  • Developers can test drafts, deploy versions, and track workflow runs.
  • Developers can use the guide to debug failed runs and resume paused ones.

Reviews (4) · Last reviewed commit: "docs(api): keep polling while a run is r..." · Reviewed by Greptile

@waleedlatif1 waleedlatif1 changed the title docs(api): guide for building and running workflows with the API, plus a plugin skill docs(api): guide for building and running workflows with the API Nov 11, 2026
@waleedlatif1
waleedlatif1 force-pushed the docs/agent-authoring-guide branch from 3c3d593 to b2d4e57 Compare November 11, 2026 21:51
@waleedlatif1

waleedlatif1 commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

waleedlatif1 commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed Nov 11, 2026
View reviewed changes

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 4 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Turn on auto-fix | Re-trigger cubic

@waleedlatif1

waleedlatif1 commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

waleedlatif1 commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed Nov 11, 2026
View reviewed changes

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 4 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Turn on auto-fix | Re-trigger cubic

@waleedlatif1

waleedlatif1 commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

@greptile

@waleedlatif1

waleedlatif1 commented Nov 11, 2026

Copy link
Copy Markdown
Collaborator Author

@cubic-dev-ai review this PR

@cubic-dev-ai

cubic-dev-ai Bot commented Nov 11, 2026

Copy link
Copy Markdown
Contributor

@cubic-dev-ai review this PR

@waleedlatif1 I have started the AI code review. It will take a few minutes to complete.

cubic-dev-ai[bot]
cubic-dev-ai Bot reviewed Nov 11, 2026
View reviewed changes

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No issues found across 4 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Turn on auto-fix | Re-trigger cubic

@waleedlatif1
waleedlatif1 merged commit c844be8 into staging Nov 11, 2026
83 checks passed
@waleedlatif1 waleedlatif1 mentioned this pull request Nov 12, 2026
Merged
@waleedlatif1
waleedlatif1 deleted the docs/agent-authoring-guide branch November 12, 2026 00:25

This branch was successfully deployed

1 active deployment
Preview — 622b27fe Deployed Nov 11, 2026 by vercel[bot]
View deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments
@cubic-dev-ai cubic-dev-ai[bot] cubic-dev-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@waleedlatif1