From 2cef12efb18207799140dc452b1b9815bd86db27 Mon Sep 17 00:00:00 2001 From: Bryan Wade Date: Thu, 17 Sep 2026 13:54:41 -0700 Subject: [PATCH 1/4] Make ComfyAPI searches reach the API overview Mintlify supports hidden page keywords for internal documentation search. Add the no-space product spelling alongside the canonical spaced name so searches from the platform discussion can discover the API overview.\n\nConstraint: Search indexing is managed by Mintlify after deployment\nRejected: Algolia dashboard synonym configuration | The repository uses Mintlify and has no Algolia search configuration\nConfidence: high\nScope-risk: narrow\nDirective: Keep product aliases in page frontmatter when they should affect internal search without changing visible copy\nTested: git diff --check\nNot-tested: Mintlify validation under Node 25 is blocked because the CLI does not support the installed Node version --- api-reference/v2/overview.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/api-reference/v2/overview.mdx b/api-reference/v2/overview.mdx index 6c9a3700c..b95ded5d1 100644 --- a/api-reference/v2/overview.mdx +++ b/api-reference/v2/overview.mdx @@ -2,6 +2,7 @@ title: "Comfy API v2 Overview" sidebarTitle: "Overview" description: "Reference for the official Comfy API v2: run ComfyUI workflows from external applications by uploading inputs, submitting jobs, and polling for results." +keywords: ["ComfyAPI", "Comfy API"] --- From f7873a6d817c18453aef573e3d915efda6477c87 Mon Sep 17 00:00:00 2001 From: Bryan Wade Date: Thu, 17 Sep 2026 15:05:45 -0700 Subject: [PATCH 2/4] Prioritize the canonical Comfy API search results The initial keyword alias made the nested v2 page searchable, but Mintlify still ranked the V3 migration anchor first because the canonical overview was not tagged and its navigation group had no search boost. Tag the canonical overview and apply a conservative group boost to the Comfy API reference section.\n\nConstraint: Mintlify documents group boost as the in-product search ranking control\nRejected: Rename the visible page title to include ComfyAPI | Unnecessary user-facing copy change\nConfidence: high\nScope-risk: narrow\nDirective: Keep the canonical Comfy API overview and its reference pages prioritized for API-intent searches\nTested: jq empty docs.json; git diff --check\nNot-tested: Live search ranking before deployment and Mintlify validation under unsupported Node 25 --- development/comfy-api/overview.mdx | 1 + docs.json | 1 + 2 files changed, 2 insertions(+) diff --git a/development/comfy-api/overview.mdx b/development/comfy-api/overview.mdx index 889549651..034e2f84f 100644 --- a/development/comfy-api/overview.mdx +++ b/development/comfy-api/overview.mdx @@ -2,6 +2,7 @@ title: "Comfy API" sidebarTitle: "Overview" description: "The public API for running ComfyUI workflows headlessly" +keywords: ["ComfyAPI", "Comfy API"] --- The public API for running ComfyUI headlessly has evolved over time. For new integrations, use [Comfy API v2](/api-reference/v2/overview). It is supported on open-source ComfyUI (during the beta, via the [API Proxy](/development/comfyui-server/api-proxy)), Comfy Cloud, and [Comfy API deployments on the Developer Platform](/development/serverless/overview). Older versions include the [v1 Cloud API](/development/cloud/overview), which is deprecated. diff --git a/docs.json b/docs.json index 5d6b3875c..5a2c2f9e9 100644 --- a/docs.json +++ b/docs.json @@ -3110,6 +3110,7 @@ "development/api-development/workflow-metadata", { "group": "Comfy API Reference", + "boost": 2, "pages": [ "development/comfy-api/overview", { From 75cec8ff8fb340475f96cb97e1ceabdb878db014 Mon Sep 17 00:00:00 2001 From: Bryan Wade Date: Thu, 17 Sep 2026 15:11:39 -0700 Subject: [PATCH 3/4] Increase Comfy API search ranking priority The staging preview showed that the exact V3 migration anchor still outranked the canonical Comfy API v2 overview with a group boost of 2. Increase the Comfy API Reference group multiplier so API-intent searches receive a stronger ranking signal.\n\nConstraint: The live staging result must prioritize the canonical API page over an unrelated migration anchor\nRejected: Modify the V3 migration content or remove its ComfyAPI heading | The heading is valid and should remain discoverable for custom-node authors\nConfidence: medium\nScope-risk: narrow\nDirective: Recheck the live preview after Mintlify reindexes; ranking is provider-controlled\nTested: jq empty docs.json; git diff --check; staging search confirmed v3 migration remained first at boost 2\nNot-tested: Staging search after this redeploy --- docs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.json b/docs.json index 5a2c2f9e9..f6e7de14f 100644 --- a/docs.json +++ b/docs.json @@ -3110,7 +3110,7 @@ "development/api-development/workflow-metadata", { "group": "Comfy API Reference", - "boost": 2, + "boost": 10, "pages": [ "development/comfy-api/overview", { From 7a16e04993f0ab5f01c047ba381b0bf2e54e0737 Mon Sep 17 00:00:00 2001 From: Bryan Wade Date: Thu, 17 Sep 2026 15:32:17 -0700 Subject: [PATCH 4/4] Let the Comfy API overview lead broad searches The live staging search still ranked the V3 migration page first because its visible subsection heading exactly matched the unspaced product query ComfyAPI. Keep the existing anchor for inbound links while using a spaced descriptive heading, allowing the canonical Comfy API overview to rank for the broad product-name search.\n\nConstraint: Preserve the existing /custom-nodes/v3_migration#comfyapi deep link\nRejected: Hide the V3 migration page from search | The page remains a valid destination for custom-node migration queries\nConfidence: medium\nScope-risk: narrow\nDirective: Treat ComfyAPI as the class name in prose and Comfy API as the product name in navigation and search-facing headings\nTested: git diff --check; jq empty docs.json\nNot-tested: Live ranking until the staging preview redeploys --- custom-nodes/v3_migration.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/custom-nodes/v3_migration.mdx b/custom-nodes/v3_migration.mdx index e65be479e..02a11f653 100644 --- a/custom-nodes/v3_migration.mdx +++ b/custom-nodes/v3_migration.mdx @@ -792,7 +792,7 @@ async def execute(cls, prompt, **kwargs) -> io.NodeOutput: return io.NodeOutput(result) ``` -### ComfyAPI +### Comfy API runtime services {#comfyapi} The `ComfyAPI` class provides access to ComfyUI runtime services like progress reporting and node replacement registration. Import it and create an instance: