fix(website): point Install via GitHub buttons to install docs anchor#11852
fix(website): point Install via GitHub buttons to install docs anchor#11852christian-byrne merged 2 commits intomainfrom
Conversation
📝 WalkthroughWalkthroughA new ChangesGitHub Install Link Configuration
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Caution Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional.
❌ Failed checks (1 error)
✅ Passed checks (6 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: Turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 👉 Get your free trial and get 200 agent minutes per Slack user (a $50 value). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🌐 Website E2ETip All tests passed.
🔗 Website PreviewWebsite Preview: https://comfy-website-preview-pr-11852.vercel.app This commit: https://website-frontend-6i27wum4y-comfyui.vercel.app Last updated: 2026-05-03T07:56:53Z for |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/website/src/config/routes.ts`:
- Line 37: The githubInstall route value (githubInstall) points to a
non-existent README anchor "#installing"; update the URL to a valid anchor or to
the README root: inspect the ComfyUI README to find the correct section anchor
(e.g., the actual heading slug such as "#manual-install-windows-linux" if
present) and replace 'https://github.com/Comfy-Org/ComfyUI#installing' with the
verified URL, or remove the fragment to link to the top-level README until the
upstream adds an "Installing" heading.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 42f2dd91-b37e-43c7-93c9-637454114ad6
📒 Files selected for processing (3)
apps/website/src/components/product/local/EcoSystemSection.vueapps/website/src/components/product/local/HeroSection.vueapps/website/src/config/routes.ts
| docs: 'https://docs.comfy.org/', | ||
| docsApi: 'https://docs.comfy.org/api-reference/cloud', | ||
| github: 'https://github.com/Comfy-Org/ComfyUI', | ||
| githubInstall: 'https://github.com/Comfy-Org/ComfyUI#installing', |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Does the ComfyUI README at https://github.com/Comfy-Org/ComfyUI currently have a heading that generates the anchor #installing?
💡 Result:
No. The current ComfyUI README at https://github.com/Comfy-Org/ComfyUI/blob/master/README.md does not have a heading whose generated anchor would be #installing. In the README’s installation section headings, the visible subheading is “Manual Install (Windows, Linux)” (and then “Instructions:” / platform-specific subheadings), rather than a heading named “Installing”, which would be required for an anchor like #installing.
Citations:
Fix the GitHub URL: the #installing anchor does not exist in the ComfyUI README
The ComfyUI README does not have a heading that generates the #installing anchor. The installation section uses headings like "Manual Install (Windows, Linux)" instead. This link will direct users to the top of the README rather than the installation section, defeating its purpose.
Either update the URL to point to an existing section (e.g., by checking the actual README structure), or coordinate with the ComfyUI team to add an "Installing" heading to their README before merging this change.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@apps/website/src/config/routes.ts` at line 37, The githubInstall route value
(githubInstall) points to a non-existent README anchor "#installing"; update the
URL to a valid anchor or to the README root: inspect the ComfyUI README to find
the correct section anchor (e.g., the actual heading slug such as
"#manual-install-windows-linux" if present) and replace
'https://github.com/Comfy-Org/ComfyUI#installing' with the verified URL, or
remove the fragment to link to the top-level README until the upstream adds an
"Installing" heading.
There was a problem hiding this comment.
Pushing back on this — the #installing anchor does exist in the upstream ComfyUI README.
Fetching the raw README right now (https://raw.githubusercontent.com/comfyanonymous/ComfyUI/master/README.md), there's a top-level heading:
# Installing…which GitHub renders with id="installing" per its slug algorithm (lowercase, spaces→hyphens). The README itself relies on this anchor — its own "Get Started" section links there:
#### [Windows Portable Package](#installing)So the link https://github.com/Comfy-Org/ComfyUI#installing jumps to the Installing section as intended. (Comfy-Org/ComfyUI redirects to comfyanonymous/ComfyUI, which serves this README.)
CodeRabbit's web search appears to have missed the # Installing H1 between the Shortcuts table and the Windows Portable subsection. No change needed.
There was a problem hiding this comment.
Skipped: comment is from another GitHub bot.
dosubot
Bot
added
the
size:XS
christian-byrne
left a comment
christian-byrne
left a comment
There was a problem hiding this comment.
Need to fix this test:
1) [desktop] › e2e/download.spec.ts:30:3 › Download page @smoke › HeroSection has download and GitHub buttons
Error: expect(locator).toHaveAttribute(expected) failed
Locator: locator('section').filter({ has: getByRole('heading', { name: /Run on your hardware/i, level: 1 }) }).getByRole('link', { name: /INSTALL FROM GITHUB/i })
Expected: "https://github.com/Comfy-Org/ComfyUI"
Received: "https://github.com/Comfy-Org/ComfyUI#installing"
Timeout: 5000ms
Call log:
- Expect "toHaveAttribute" with timeout 5000ms
- waiting for locator('section').filter({ has: getByRole('heading', { name: /Run on your hardware/i, level: 1 }) }).getByRole('link', { name: /INSTALL FROM GITHUB/i })
9 × locator resolved to <a href="https://github.com/Comfy-Org/ComfyUI#installing" class="inline-flex flex-nowrap items-center justify-center cursor-pointer font-bold tracking-wider transition-colors gap-2 text-nowrap border-primary-comfy-yellow text-primary-comfy-yellow hover:bg-primary-comfy-yellow hover:text-primary-comfy-ink border rounded-2xl px-4 py-2 text-sm lg:min-w-60 lg:p-4">…</a>
- unexpected value "https://github.com/Comfy-Org/ComfyUI#installing"
45 | const githubBtn = hero.getByRole('link', { name: /INSTALL FROM GITHUB/i })
46 | await expect(githubBtn).toBeVisible()
> 47 | await expect(githubBtn).toHaveAttribute(
| ^
48 | 'href',
49 | 'https://github.com/Comfy-Org/ComfyUI'
50 | )
at /__w/ComfyUI_frontend/ComfyUI_frontend/apps/website/e2e/download.spec.ts:47:29
Error Context: test-results/download-Download-page-smo-527d3-download-and-GitHub-buttons-desktop/error-context.md
Retry #1 ───────────────────────────────────────────────────────────────────────────────────────
Error: expect(locator).toHaveAttribute(expected) failed
Locator: locator('section').filter({ has: getByRole('heading', { name: /Run on your hardware/i, level: 1 }) }).getByRole('link', { name: /INSTALL FROM GITHUB/i })
Expected: "https://github.com/Comfy-Org/ComfyUI"
Received: "https://github.com/Comfy-Org/ComfyUI#installing"
Timeout: 5000ms
Call log:
- Expect "toHaveAttribute" with timeout 5000ms
- waiting for locator('section').filter({ has: getByRole('heading', { name: /Run on your hardware/i, level: 1 }) }).getByRole('link', { name: /INSTALL FROM GITHUB/i })
9 × locator resolved to <a href="https://github.com/Comfy-Org/ComfyUI#installing" class="inline-flex flex-nowrap items-center justify-center cursor-pointer font-bold tracking-wider transition-colors gap-2 text-nowrap border-primary-comfy-yellow text-primary-comfy-yellow hover:bg-primary-comfy-yellow hover:text-primary-comfy-ink border rounded-2xl px-4 py-2 text-sm lg:min-w-60 lg:p-4">…</a>
- unexpected value "https://github.com/Comfy-Org/ComfyUI#installing"
45 | const githubBtn = hero.getByRole('link', { name: /INSTALL FROM GITHUB/i })
46 | await expect(githubBtn).toBeVisible()
> 47 | await expect(githubBtn).toHaveAttribute(
| ^
48 | 'href',
49 | 'https://github.com/Comfy-Org/ComfyUI'
50 | )
at /__w/ComfyUI_frontend/ComfyUI_frontend/apps/website/e2e/download.spec.ts:47:29
Error Context: test-results/download-Download-page-smo-527d3-download-and-GitHub-buttons-desktop-retry1/error-context.md
attachment #2: trace (application/zip) ─────────────────────────────────────────────────────────
test-results/download-Download-page-smo-527d3-download-and-GitHub-buttons-desktop-retry1/trace.zip
Usage:
pnpm exec playwright show-trace test-results/download-Download-page-smo-527d3-download-and-GitHub-buttons-desktop-retry1/trace.zip
────────────────────────────────────────────────────────────────────────────────────────────────
Retry #2 ───────────────────────────────────────────────────────────────────────────────────────
Error: expect(locator).toHaveAttribute(expected) failed
Locator: locator('section').filter({ has: getByRole('heading', { name: /Run on your hardware/i, level: 1 }) }).getByRole('link', { name: /INSTALL FROM GITHUB/i })
Expected: "https://github.com/Comfy-Org/ComfyUI"
Received: "https://github.com/Comfy-Org/ComfyUI#installing"
Timeout: 5000ms
Call log:
- Expect "toHaveAttribute" with timeout 5000ms
- waiting for locator('section').filter({ has: getByRole('heading', { name: /Run on your hardware/i, level: 1 }) }).getByRole('link', { name: /INSTALL FROM GITHUB/i })
9 × locator resolved to <a href="https://github.com/Comfy-Org/ComfyUI#installing" class="inline-flex flex-nowrap items-center justify-center cursor-pointer font-bold tracking-wider transition-colors gap-2 text-nowrap border-primary-comfy-yellow text-primary-comfy-yellow hover:bg-primary-comfy-yellow hover:text-primary-comfy-ink border rounded-2xl px-4 py-2 text-sm lg:min-w-60 lg:p-4">…</a>
- unexpected value "https://github.com/Comfy-Org/ComfyUI#installing"
45 | const githubBtn = hero.getByRole('link', { name: /INSTALL FROM GITHUB/i })
46 | await expect(githubBtn).toBeVisible()
> 47 | await expect(githubBtn).toHaveAttribute(
| ^
48 | 'href',
49 | 'https://github.com/Comfy-Org/ComfyUI'
50 | )
at /__w/ComfyUI_frontend/ComfyUI_frontend/apps/website/e2e/download.spec.ts:47:29
Error Context: test-results/download-Download-page-smo-527d3-download-and-GitHub-buttons-desktop-retry2/error-context.md
1 failed
[desktop] › e2e/download.spec.ts:30:3 › Download page @smoke › HeroSection has download and GitHub buttons
113 passed (2.2m)
/__w/ComfyUI_frontend/ComfyUI_frontend/apps/website:
ERR_PNPM_RECURSIVE_RUN_FIRST_FAIL @comfyorg/website@0.0.1 test:e2e: `playwright test`
Exit status 1
|
Fixed the e2e test — Verified locally: |
4 participants
PR Created by the Glary-Bot Agent
Summary
Updates the "Install via GitHub" CTA buttons on the
/downloadpage to deep-link to the install instructions section of the ComfyUI README (#installing) instead of the repo root, so users land directly on setup steps.Changes
apps/website/src/config/routes.ts: addexternalLinks.githubInstall = 'https://github.com/Comfy-Org/ComfyUI#installing'(separate fromexternalLinks.github, which is still used by the navbar/footer/star badge for the generic repo link).apps/website/src/components/product/local/HeroSection.vue: switch the secondary CTA next to "Download Local" fromexternalLinks.githubtoexternalLinks.githubInstall.apps/website/src/components/product/local/EcoSystemSection.vue: same swap on the ecosystem-section CTA.The platform-aware
Download Localbutton (Windows/macOS installers viauseDownloadUrl) and the generic GitHub social/repo links elsewhere on the site are unchanged.Verification
pnpm --filter @comfyorg/website typecheck— 0 errorspnpm --filter @comfyorg/website test:unit— 23/23 passingpnpm exec eslinton changed files — cleanpnpm exec oxfmt --check— cleanpnpm dev+ Playwright DOM assertion on/download:https://github.com/Comfy-Org/ComfyUI#installing✓https://github.com/Comfy-Org/ComfyUI#installing✓https://github.com/Comfy-Org/ComfyUI✓Per request from #website-and-docs: the local download surfaces should at least link to the ComfyUI install instructions on GitHub. Companion change to comfy-org/website#227.
Screenshots
┆Issue is synchronized with this Notion page by Unito