Skip to content

Simplify developer onboarding and add a runnable first workflow - #1686

Merged
stale2000 merged 5 commits into
mainfrom
stale2000/development-overview-use-cases
Sep 16, 2026
Merged

stale2000 merged 5 commits into
mainfrom
stale2000/development-overview-use-cases

Conversation

@stale2000

@stale2000 stale2000 commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Replace the expanded developer landing-page sections with four concise use-case cards above Quick Start.
  • Add a focused Workflow API quickstart with a bundled model-free workflow.
  • Add runnable Python and TypeScript clients that submit the workflow and save its output.
  • Reconcile the Router capabilities page with the canonical queued-delivery guide.

Verification

  • mint validate
  • mint broken-links
  • JSON, Python, and Node syntax checks
  • Local rendered-page review of the four-card overview layout
  • git diff --check

No live Comfy Cloud request was made; remote execution and downloads were mocked.

The development landing page now presents its four primary paths together before the existing workflow quickstart, with one destination and a concise description per path.

Constraint: Preserve the existing Quick Start guide and its current upstream copy.

Rejected: Keep the supplemental More grid | the request calls for exactly four use-case panels.

Confidence: high

Scope-risk: narrow

Reversibility: clean

Tested: Mintlify strict build validation under Node 22.22.2; local desktop preview of the card grid and Quick Start transition

Not-tested: Dedicated mobile viewport
The new queued-delivery guide landed while the capabilities page still described Router as synchronous-only. Reconcile that page with the gated preview and point readers to the canonical queue guide instead of duplicating its examples.

Constraint: Queued delivery is a caller-gated preview and returns 403 not_enabled when unavailable.

Rejected: Keep the separate API-guide summary | upstream now has a dedicated queue guide and model examples, so another summary would duplicate them.

Confidence: high

Scope-risk: narrow

Directive: Update queue semantics at the upstream contract before changing generated reference text.

Tested: Mintlify strict validation; Mintlify broken-link check; unauthenticated live requests reached all four api.comfy.org queue routes and returned 401 with request IDs

Not-tested: Authenticated queued generation because it can consume credits and is rollout-gated
The canonical queue guide scopes preview enablement and not_enabled responses to a workspace, so the capabilities page now uses the same term.

Constraint: Leave the surrounding lifecycle description unchanged.

Confidence: high

Scope-risk: narrow

Tested: Mintlify strict validation; git diff --check
@mintlify

mintlify Bot commented Sep 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
comfy 🟢 Ready View Preview Sep 16, 2026, 12:16 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Sep 15, 2026

Copy link
Copy Markdown

Warning

Review limit reached

  • Run on-demand review

On-demand reviews are free for the next 24 days. After that, they cost $0.25 per reviewed file.

Or wait 15 minutes for your next included review.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 0664839f-49f2-475e-8ac3-6890f6d1e0db

📥 Commits

Reviewing files that changed from the base of the PR and between e6ce335 and 5f2066c.

📒 Files selected for processing (7)
  • development/api-development/quickstart.mdx
  • development/comfy-router/limitations.mdx
  • development/overview.mdx
  • docs.json
  • files/api-first-result/first_workflow.mts
  • files/api-first-result/first_workflow.py
  • files/api-first-result/workflow_api.json

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 15, 2026

Copy link
Copy Markdown

🌐 i18n translation sync reminder

@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files:

Japanese (ja)

  • ja/development/api-development/quickstart.mdx
  • ja/development/comfy-router/limitations.mdx
  • ja/development/overview.mdx
  • ja/development/api-development/quickstart.mdx

Simplified Chinese (zh)

  • zh/development/api-development/quickstart.mdx
  • zh/development/comfy-router/limitations.mdx
  • zh/development/overview.mdx
  • zh/development/api-development/quickstart.mdx

Korean (ko)

  • ko/development/api-development/quickstart.mdx
  • ko/development/comfy-router/limitations.mdx
  • ko/development/overview.mdx
  • ko/development/api-development/quickstart.mdx

Local sync: npm run translate (see README — Automated translation)

Queued delivery is a released API and SDK feature whose availability is still expanding by workspace. Describe the two delivery modes directly and reserve the access caveat for the availability section.

Constraint: Workspaces without queue access still receive 403 not_enabled.

Rejected: Remove the rollout caveat | universal enablement is not yet documented.

Confidence: high

Scope-risk: narrow

Tested: Mintlify strict validation; git diff --check
stale2000 added a commit that referenced this pull request Sep 16, 2026
Publish a model-free API-format workflow with Python and TypeScript clients so developers can verify authentication, execution, and output download without finding a compatible community workflow first.

Constraint: The first workflow must not depend on model availability or custom nodes.

Rejected: Rewrite the developer landing page | PR #1686 owns that information architecture.

Rejected: Add a second quickstart hub to the API-key page | the dedicated quickstarts already provide the next steps.

Confidence: high

Scope-risk: narrow

Tested: Link and anchor validation; SDK workflow parsing and mocked downloads; strict TypeScript and Node syntax checks.

Not-tested: Live Comfy Cloud execution.
Publish a model-free API-format workflow with Python and TypeScript clients so developers can verify authentication, execution, and output download without finding a compatible community workflow first.

Constraint: The first workflow must not depend on model availability or custom nodes.

Rejected: Rewrite the developer landing page | PR #1686 owns that information architecture.

Rejected: Add a second quickstart hub to the API-key page | the dedicated quickstarts already provide the next steps.

Confidence: high

Scope-risk: narrow

Tested: Link and anchor validation; SDK workflow parsing and mocked downloads; strict TypeScript and Node syntax checks.

Not-tested: Live Comfy Cloud execution.
@stale2000 stale2000 changed the title Simplify the developer landing page and clarify Router limits Simplify developer onboarding and add a runnable first workflow Sep 16, 2026
@stale2000
stale2000 merged commit 59ca5fc into main Sep 16, 2026
15 checks passed
@github-actions
github-actions Bot deleted the stale2000/development-overview-use-cases branch September 16, 2026 00: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