Skip to content

docs: improve ComfyAPI search discovery - #1700

Open
stale2000 wants to merge 4 commits into
mainfrom
comfy/docs-comfyapi-search
Open

stale2000 wants to merge 4 commits into
mainfrom
comfy/docs-comfyapi-search

Conversation

@stale2000

@stale2000 stale2000 commented Sep 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add ComfyAPI and Comfy API as Mintlify internal search keywords to the canonical Comfy API overview.
  • Boost the English Comfy API Reference navigation group so API-intent searches outrank unrelated V3 migration and built-in-node results.
  • Keep the nested v2 overview tagged as an API-specific destination.

Context

This addresses the Slack report and screenshot: https://comfy-organization.slack.com/archives/C0BD6BR53QX/p1789670184238569

The screenshot shows comfyapi returning the V3 migration ComfyAPI anchor first, followed by unrelated built-in-node and changelog sections. The Slack follow-up identified Mintlify page keywords as the appropriate fix. Keywords alone improve discoverability but do not guarantee ranking, so this also uses Mintlify's documented navigation-group boost setting.

Verification

  • jq empty docs.json passed.
  • git diff --check passed.
  • npx mint validate could not run because the installed Node.js 25.9.0 is unsupported by the Mintlify CLI.
  • Live search ranking requires deployment and index refresh.

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
@mintlify

mintlify Bot commented Sep 17, 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 17, 2026, 10:34 PM

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

@coderabbitai

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Warning

Review paused — included plan limit reached

Keep your review moving with free on-demand reviews.

  • Run this review for free

On-demand reviews are free for the next 22 days.

Promotion and pricing details

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

Review limit details

Or wait 19 minutes for your next included review.

Check out review usage here.

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: d4a3b55e-ef2f-472e-ab2a-53810cd582b4

📥 Commits

Reviewing files that changed from the base of the PR and between f7873a6 and 7a16e04.

📒 Files selected for processing (2)
  • custom-nodes/v3_migration.mdx
  • docs.json

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: f82c74e1-c8d9-49f6-8018-8d1c4e4e0c53

📥 Commits

Reviewing files that changed from the base of the PR and between 2cef12e and f7873a6.

📒 Files selected for processing (2)
  • development/comfy-api/overview.mdx
  • docs.json

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The API overview pages now include Comfy API keywords. The Comfy API Reference search configuration now has a boost value of 2.

Changes

Comfy API search metadata

Layer / File(s) Summary
Overview keyword metadata
api-reference/v2/overview.mdx, development/comfy-api/overview.mdx
Both overview pages add ComfyAPI and Comfy API to their frontmatter keywords.
Search ranking configuration
docs.json
The Comfy API Reference group adds a search boost value of 2.

Priority: ⬇️ Low

Merge Risk: ⚪ Minimal · up to f7873

The changes only adjust documentation search metadata and configuration; no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
✨ Simplify code
  • Commit to this branch
  • Create a new PR

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

@github-actions

github-actions Bot commented Sep 17, 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/api-reference/v2/overview.mdx
  • ja/custom-nodes/v3_migration.mdx
  • ja/development/comfy-api/overview.mdx

Simplified Chinese (zh)

  • zh/api-reference/v2/overview.mdx
  • zh/custom-nodes/v3_migration.mdx
  • zh/development/comfy-api/overview.mdx

Korean (ko)

  • ko/api-reference/v2/overview.mdx
  • ko/custom-nodes/v3_migration.mdx
  • ko/development/comfy-api/overview.mdx

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

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
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
@stale2000
stale2000 marked this pull request as ready for review September 17, 2026 22:12
@stale2000
stale2000 marked this pull request as draft September 17, 2026 22:14
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
@stale2000
stale2000 marked this pull request as ready for review September 17, 2026 22:32
@stale2000
stale2000 marked this pull request as draft September 17, 2026 22:35
@stale2000
stale2000 marked this pull request as ready for review September 17, 2026 22:43
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