feat: rename Cloud & Partner APIs group to ComfyUI APIs, add Server API overview and quick start#3
Open
lin-bot23 wants to merge 20 commits into
Open
feat: rename Cloud & Partner APIs group to ComfyUI APIs, add Server API overview and quick start#3lin-bot23 wants to merge 20 commits into
lin-bot23 wants to merge 20 commits into
Conversation
…PI overview and quick start - Rename side navigation group 'Cloud & Partner APIs' → 'ComfyUI APIs' - Remove redundant 'ComfyUI Server' group from Development tab (merged into APIs) - Add new development/apis/overview.mdx with API comparison table (EN/ZH/JA) - Add new development/comfyui-server/server-guide.mdx as entry point (EN/ZH/JA) - Add new development/comfyui-server/quick-start.mdx with 3 code patterns (EN/ZH/JA) - HTTP only (basic_api_example) - WebSocket + History (websockets_api_example) - SaveImageWebsocket real-time images (websockets_api_example_ws_images) - Update development/overview.mdx references and links - Update docs.json for all 3 languages
lin-bot23
force-pushed
the
apis/rename-group-to-comfyui-apis
branch
from
ad41d8f to
967845d
Compare
- Merge server startup guide and navigation cards into comms_overview - Rename comms_overview title to 'Server Overview' with full entry content - Delete server-guide.mdx (EN/ZH/JA) - Reorder sidebar: Overview → Routes → API Examples → Messages → Inversion - Update links in api-development/overview
…entralized getting-an-api-key page
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
2 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.
Summary
Renames the side navigation group from "Cloud & Partner APIs" to "ComfyUI APIs" and adds a new ComfyUI Server API section with both an overview page and a quick-start guide.
Changes
Navigation (docs.json, all 3 languages)
New Files (EN/ZH/JA)
development/apis/overview.mdxdevelopment/comfyui-server/server-guide.mdxdevelopment/comfyui-server/quick-start.mdxExisting Files Modified
development/overview.mdx— Updated references from oldcomms_overviewto newserver-guide, added link to APIs overviewQuick Start Content
The quick-start page demonstrates three patterns based on the official script_examples:
basic_api_example.py)websockets_api_example.py)websockets_api_example_ws_images.py)All examples are Python-focused (matching the original repo scripts), with notes pointing to the existing Cloud API Reference for TypeScript/curl equivalents.