Repository navigation
docs(desktop): consolidate open lin-bot23 Desktop PRs - #1962
Merged
Merged
Conversation
Add four screenshots to installation/desktop/usage/performance-tests.mdx, the page added in this PR: - the Performance Tests panel with the three numbered steps - the example workflow picker with its modality tabs and cards - the Benchmarks runs library with its filters - the Benchmarks relative speed view with a baseline Captured from a local build of Comfy Desktop v1.1.7 (English UI), 1600px wide. The Benchmarks shots use two seeded demo sessions because a real run needs a local instance and a workflow's full runtime.
The "Trailing Buttons" section of the Comfy Desktop usage overview listed only three of the controls on the right side of the title bar. It now covers all of them, in UI order, and adds the one detail that was missing from the instance pill description. - What's new bell: opens the announcements panel; the bell carries a dot until an announcement is opened. - Reset Zoom pill: appears only while the ComfyUI view is zoomed off 100%. - Downloads tray: what the badge shows, and what the tray can do, with the full list called out separately. - Instance Switcher: the center pill's inline Update chip, which updates the instance without opening the picker. Also normalized the full-width colons in the rewritten EN bullets to ASCII. Sources: Comfy-Org/Comfy-Desktop @ origin/main (68774676) - src/renderer/src/comfyTitleBar/TitleBarApp.vue, src/renderer/src/composables/useAnnouncement.ts, src/renderer/src/components/AnnouncementModal.vue, src/renderer/src/comfyTitlePopup/DownloadsView.vue, src/renderer/src/comfyTitlePopup/DownloadsFullView.vue, src/main/index.ts, locales/en.json.
Add a First Launch section to installation/desktop/overview.mdx covering the first-run takeover that runs the first time the launcher starts: the Cloud or Local choice and the hardware recommendation, the required terms checkbox plus the optional telemetry and beta opt-ins, the Express Install checkbox, migrating a detected Legacy Desktop install, the Chinese mirror prompt, and what happens after Continue. Replace the stale "Welcome screen" sentence in windows.mdx with a pointer to that section, since the first screen asks how to run Comfy rather than offering a first installation. Facts taken from Comfy-Org/Comfy-Desktop origin/main: src/renderer/src/views/FirstUseTakeover.vue, src/shared/firstUseMode.ts, src/main/popups/titlePopup.ts, src/main/lib/firstUseDetection.ts and locales/en.json (UI strings quoted verbatim, zh strings cross-checked against locales/zh.json). zh/ja/ko translated in the same commit; hashes re-synced for both pages.
Add a Launching, Stopping, and Restarting an Instance section to the Instance Management page: how launching works, the multi-instance warning (Close & Launch / Run All) and its preference, the stopped card with Relaunch ComfyUI, and the crash card with Restart ComfyUI. Sources: src/renderer/src/composables/useLocalInstanceGuard.ts, src/renderer/src/panel/ComfyLifecycleView.vue, locales/en.json (launch.instanceRunning*, comfyLifecycle.*). Also fixes a pre-existing ja drift: the identifier in the Python environment example is now the byte-identical <ComfyUI_dir>.
The migration page described a first-launch prompt with a Migrate Now button, a Legacy Desktop option in the New Instance picker, and a copy-based migration that leaves a fresh Python environment behind. None of that matches the app: - the first-run setup offers "Migrate existing instance" on the Local branch (selected by default) and the chain continues on **Continue**, which opens the migrate confirm surface; migration starts on **Start Migration** - the Legacy Desktop source is hidden from the picker and migration-only - a Legacy Desktop migrate-to-standalone run adopts the install in place: the data folder, Python environment, and models are reused, and the ComfyUI source is staged into a new managed directory. The reused environment is therefore not an untouched backup, so the page no longer promises one - tracked Git and portable installs migrate from their card's Migrate pill (or the Migrate to Standalone menu item); a pending update takes priority Verified against Comfy-Desktop origin/main: src/main/sources/desktop.ts (hidden, migration-only), getStatusTag() in sources/desktop.ts, sources/git.ts, sources/portable.ts, ChooserInstallTile.vue (hasMigratePrompt), useInstallContextMenu.ts (menuMigrate), src/main/lib/ipc/sessionActions/migrate.ts (sourceId === 'desktop' -> adoptDesktopInstall), src/main/lib/desktopAdopt.ts, useAdoptAction.ts (reuse list), FirstUseTakeover.vue routePostStart, and panel/useFirstUseChain.ts (chain-migrate).
Fold in the Desktop FAQ Ollama entry from #1277 (EN + zh/ja/ko) and refresh translationSourceHash / block hashes for overview and FAQ after merging the open lin-bot23 Desktop PRs onto main.
…sktop 1.1.7 Replace outdated Dashboard, instance menu, install progress, Settings, Manage, Performance Tests, and Benchmarks images with captures from Comfy Desktop 1.1.7 on Linux. Add first-run Cloud/Local shots, Linux install wizard, Low Disk Space dialog, app menu, and title-bar trailing controls; clarify alt captions.
Fill the two gaps left after the Linux 1.1.7 screenshot pass: - benchmarks_02_relative_speed.png — Benchmarks Speed view with three seeded Performance Test sessions (RTX 4090 / 4070 / 3080) so the relative-speed chart renders (baseline, slower, faster). - comfy_desktop_settings_03-2_storage.png — Storage tab with a second shared models directory and the row "…" menu open (Use for Model Downloads / Remove). Numbers, GPU names, and paths are seeded/demo data written into ~/ComfyUI-Shared/benchmarks and settings.json in an isolated user-data-dir; no real Performance Test was run (box has no GPU). Do not merge until reviewed.
Crop of the Dashboard top-left ☰ menu with theme-yellow (#E8F800) callout on Performance Tests; clarify entry is not a left sidebar.
… (1) ☰ and (2) callouts Partial dashboard crop from the live seeded Desktop 1.1.7 UI, ☰ menu open. Callouts follow #1952 style (#E8F800, black-digit circles).
Add the new Desktop screenshots (first-run, app menu, title bar, Linux wizard tab, low disk space, Performance Tests menu entry) to the localized pages so structure-parity matches English; sync translation hashes.
…Make primary' Storage settings ⋯ menu and DOWNLOADS badge wording in en/zh/ja/ko settings and downloads pages; sync translation hashes.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
5 tasks
|
Warning Review limit reached
This review includes 45 billable files and costs up to $11.25. Or wait 9 minutes for your next included review. View limit details
Comment |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Consolidates the open lin-bot23 Desktop documentation PRs into a single branch on top of current
main(includes the already-merged short disk-space notes from #1933).Supersedes: #1835, #1836, #1858, #1867, #1873, #1899, #1919, #1277
Included content
overview,windows)Excluded from this consolidation (not Desktop app docs)
development/comfyui-server/startup-flagsonlyDesktop section structure (unchanged folders, filled out)
installation/desktop/overview(first-run), OS install pages,usage/migrateusage/overview(title bar),instance-management(create + launch/stop/crash + disk-space from docs(desktop): short disk-space notes on instance creation (+ FAQ) #1933),settings/manage(beta + tabs),performance-tests, downloads / snapshots / workspacesinstallation/desktop/faq(update checks, disk space, Ollama, existing troubleshooting)i18n: cherry-picked locale files from each PR; refreshed
translationSourceHash/ block hashes withbun run translate:sync-hashfor FAQ and overview after consolidating.Test plan
Does not merge the superseded PRs; those will be closed pointing here.
Note
Low Risk
Documentation and navigation-only changes with no application code; risk is limited to doc accuracy or i18n parity on touched locales.
Overview
This PR expands Comfy Desktop documentation across English and mirrored zh/ja/ko pages, and wires a new nav entry for Performance Tests in
docs.json.New and expanded guides: A full Performance Tests and Benchmarks page describes timed workflow runs, the Benchmarks library, and where
benchmarks/session data is stored. Overview and Windows now document the first-run flow (cloud vs local, terms/telemetry/beta opt-in, express install, legacy migration, Chinese mirrors). Usage overview documents the ☰ app menu, title-bar controls (updates, zoom, What's new, downloads), and links to performance testing.Instance lifecycle and migration: Instance management adds Linux install wizard screenshots, launch/stop/multi-instance dialogs, and crash / asset-database recovery notes. Migrate is rewritten for in-place reuse of data and Python (with backup caveats) and Chooser-based migration; migrate snippets match that story.
Settings and storage terminology: Settings and Manage cover beta features (
+N betastartup args). Shared model storage docs rename Primary to DOWNLOADS / Use for Model Downloads (downloads page aligned).FAQ: New accordions on non-disableable update checks (including Linux
.deb) and Ollama via custom nodes (not native diffusion backend).Reviewed by Cursor Bugbot for commit d5fd0ec. Bugbot is set up for automated code reviews on this repo. Configure here.
Reopened from an upstream branch (supersedes #1961, which was fork-based) so the preview build runs.