Simplify developer onboarding and add a runnable first workflow - #1686
Conversation
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
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Warning Review limit reached
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. View limit detailsLimit details: You’ve used all 2 included reviews currently available. Review configuration: ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (7)
Comment |
🌐 i18n translation sync reminder@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files: Japanese (
|
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
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.
Summary
Verification
mint validatemint broken-linksgit diff --checkNo live Comfy Cloud request was made; remote execution and downloads were mocked.