Conversation
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
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Warning Review paused — included plan limit reachedKeep your review moving with free on-demand reviews.
On-demand reviews are free for the next 22 days. Promotion and pricing detailsOn-demand reviews are free for the next 22 days. After that, they cost $0.25 per reviewed file. Review limit detailsOr wait 19 minutes for your next included review. Limit 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 (2)
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (2)
Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe API overview pages now include Comfy API keywords. The Comfy API Reference search configuration now has a boost value of 2. ChangesComfy API search metadata
Priority: ⬇️ Low Merge Risk: ⚪ Minimal · up to The changes only adjust documentation search metadata and configuration; no actionable merge-blocking risk remains. 🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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 (
|
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
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
Summary
ComfyAPIandComfy APIas Mintlify internal search keywords to the canonical Comfy API overview.Context
This addresses the Slack report and screenshot: https://comfy-organization.slack.com/archives/C0BD6BR53QX/p1789670184238569
The screenshot shows
comfyapireturning the V3 migrationComfyAPIanchor first, followed by unrelated built-in-node and changelog sections. The Slack follow-up identified Mintlify pagekeywordsas the appropriate fix. Keywords alone improve discoverability but do not guarantee ranking, so this also uses Mintlify's documented navigation-groupboostsetting.Verification
jq empty docs.jsonpassed.git diff --checkpassed.npx mint validatecould not run because the installed Node.js 25.9.0 is unsupported by the Mintlify CLI.