Skip to content

docs(desktop): document the example workflow picker and fix the warm-up run range - #2246

Merged
comfyui-wiki merged 3 commits into
Comfy-Org:mainfrom
lin-bot23:desktop-docs-1104
Nov 4, 2026
Merged

comfyui-wiki merged 3 commits into
Comfy-Org:mainfrom
lin-bot23:desktop-docs-1104

Conversation

@lin-bot23

@lin-bot23 lin-bot23 commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

What changed

installation/desktop/usage/performance-tests.mdx in EN, zh, ja, ko and es.

  • Warm-up run range corrected: the field takes 0 to 5, and 0 skips the warm-up. Checked against the running app (min=0, max=5 on the input).
  • "Choose a workflow" cut down: the four dense paragraphs became three short ones, and the bundled example table (stale every release) is gone.
  • Three screenshots, captured from Comfy Desktop v1.1.8 on macOS:
    • performance_tests_02_example_workflows.png (replaced): modality tabs, per-card download size, and the Downloaded tooltip on a card whose models are already on disk.
    • performance_tests_03_example_download.png (new): the drop zone mid-download, Run disabled, the trash button tooltipped Cancel download.
    • performance_tests_04_disk_warning.png (new): the disk warning above the cards, Use workflow disabled.

Sources

  • src/renderer/src/views/PerformanceTestView.vue: warm-up clamp correctRunCount(value, 0, 5, 1), canRun excluding an example download, drop-zone progress.
  • src/renderer/src/components/TemplatePickerStep.vue: the hard-drive icon whose tooltip reads Downloaded, the disk warning above the cards.
  • src/main/lib/performanceTestExampleWorkflows.ts: modelsPresent and the free space of the models dir.
  • Upstream feature: https://github.com/Comfy-Org/ComfyDesktop/pull/1607

Checks

  • EN plus zh/ja/ko/es in one PR; check-i18n-sync passes.
  • Heading and fence parity across the five files: ## 4, ### 9, fences 2, images 7.
  • No em dashes; changed paths are only under installation/desktop/** and images/desktop/usage/**.

@mintlify

mintlify Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

✅ Preview approved

@comfyui-wiki approved a Mintlify preview for commit a76dc77.

@coderabbitai

coderabbitai Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Explain Change →

Walkthrough

The performance test guides in five locales now describe workspace-scoped instance lists and expanded example workflow selection and downloads. The warm-up range now starts at zero, which skips warm-up runs.

Changes: Performance test documentation

Layer / File(s) Summary
Workspace-scoped instance selection
installation/desktop/usage/performance-tests.mdx, es/installation/desktop/usage/performance-tests.mdx, ja/installation/desktop/usage/performance-tests.mdx, ko/installation/desktop/usage/performance-tests.mdx, zh/installation/desktop/usage/performance-tests.mdx
The guides state that the instance list is filtered by the selected workspace. Translated pages also update panel image descriptions or narrow-window layout details.
Example workflow selection and downloads
installation/desktop/usage/performance-tests.mdx, es/installation/desktop/usage/performance-tests.mdx, ja/installation/desktop/usage/performance-tests.mdx, ko/installation/desktop/usage/performance-tests.mdx, zh/installation/desktop/usage/performance-tests.mdx
The guides describe example categories, model download status and controls, picker requirements, failure handling, and behavior when switching instances.
Warm-up settings and translation updates
installation/desktop/usage/performance-tests.mdx, es/installation/desktop/usage/performance-tests.mdx, ja/installation/desktop/usage/performance-tests.mdx, ko/installation/desktop/usage/performance-tests.mdx, zh/installation/desktop/usage/performance-tests.mdx
Warm-up runs now allow a minimum of zero, which skips warm-up. Translated pages update translation hashes; the Chinese page also translates button labels and updates the measurement-step heading.

Possibly related PRs

Merge Risk: Minimal · up to a76dc

The documentation clarifies workspace selection, example downloads, and zero warm-up runs. No concrete merge-blocking issue is established; compatibility of the Spanish picker labels remains unverified.

Pre-merge checks: Passed 2
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)
  • Create a new PR
Simplify code
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

@coderabbitai
coderabbitai Bot requested a review from comfyui-wiki November 4, 2026 08:10
@mintlify

mintlify Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
comfy 🟢 Ready View Preview Nov 4, 2026, 12:31 PM

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional comments: 1
es/installation/desktop/usage/performance-tests.mdx-44-44: 1

44-44: Minor · Potential issue · Low value

Unverified finding
We couldn't verify this from the code. It is shown for review, not as a verified issue.

The new Spanish instructions give translated picker control labels, while the same guide identifies the existing run controls as Run and Stop. If the Spanish Desktop picker also uses English labels, the newly translated labels will not identify clickable controls.

The reader cannot match Elegir un flujo de trabajo de ejemplo or Usar flujo de trabajo to the displayed controls.

This can occur when: A reader follows the Spanish guide in a Desktop installation whose picker labels remain in English.

Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 92946493-ecb6-45f3-8950-b05a2fe64049
Commits

Reviewing files that changed from the base of the PR and between 33b68e3 and a76dc77.

Files ignored due to path filters: 3
  • images/desktop/usage/performance_tests_02_example_workflows.png is excluded by !**/*.png
  • images/desktop/usage/performance_tests_03_example_download.png is excluded by !**/*.png
  • images/desktop/usage/performance_tests_04_disk_warning.png is excluded by !**/*.png
Files selected for processing: 5
  • es/installation/desktop/usage/performance-tests.mdx
  • installation/desktop/usage/performance-tests.mdx
  • ja/installation/desktop/usage/performance-tests.mdx
  • ko/installation/desktop/usage/performance-tests.mdx
  • zh/installation/desktop/usage/performance-tests.mdx

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

@comfyui-wiki
comfyui-wiki merged commit fd5b6ea into Comfy-Org:main Nov 4, 2026
15 checks passed

This branch was successfully deployed

1 active deployment
staging — a76dc77c Deployed Nov 4, 2026 by mintlify[bot]
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.

2 participants