Skip to content

docs: improve ComfyAPI search discovery - #1699

Closed
stale2000 wants to merge 1 commit into
Comfy-Org:mainfrom
stale2000:stale2000/docs-comfyapi-search
Closed

stale2000 wants to merge 1 commit into
Comfy-Org:mainfrom
stale2000:stale2000/docs-comfyapi-search

Conversation

@stale2000

Copy link
Copy Markdown
Contributor

Summary

  • Add ComfyAPI and Comfy API as Mintlify internal search keywords for the canonical Comfy API v2 overview.
  • Help searches using the no-space spelling discover the API documentation instead of relying only on the V3 migration anchor.

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.

Verification

  • git diff --check passed.
  • npx mint validate could not run because the installed Node.js 25.9.0 is unsupported by the Mintlify CLI.

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

coderabbitai Bot commented Sep 17, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

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

@stale2000

Copy link
Copy Markdown
Contributor Author

Superseded by upstream Comfy branch PR #1700.

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