Skip to content

Add ComfyUI Desktop 2.0 user documentation#972

Open
lin-bot23 wants to merge 1 commit intoComfy-Org:mainfrom
lin-bot23:add-desktop-2-docs
Open

Add ComfyUI Desktop 2.0 user documentation#972
lin-bot23 wants to merge 1 commit intoComfy-Org:mainfrom
lin-bot23:add-desktop-2-docs

Conversation

@lin-bot23
Copy link
Copy Markdown
Contributor

Summary

Adds comprehensive user documentation for ComfyUI Desktop 2.0 (https://github.com/Comfy-Org/ComfyUI-Desktop-2.0-Beta) based on analysis of the app's source code (Vue 3 + Electron).

Changes

New files

File Content
installation/desktop-2/overview.mdx Overview explaining Desktop 2.0 as a multi-installation manager, key features, system requirements, comparison with Desktop 1.0
installation/desktop-2/windows.mdx Windows-specific install guide with download links, step-by-step setup, Quick Install vs Track Existing flow
installation/desktop-2/macos.mdx macOS-specific install guide (Apple Silicon only)
installation/desktop-2/linux.mdx Linux install guide (.deb and AppImage), XDG data paths
installation/desktop-2/usage.mdx Comprehensive usage guide covering Chooser view, managing installations, snapshots, model downloads, in-app terminal, global settings, keyboard shortcuts

Navigation

Added Desktop 2.0 (Beta) section to the installation sidebar in docs.json.

What's covered

All documented features are based on analysis of the actual source code:

  • Multi-installation management — Standalone, Cloud, Git Clone, Portable, Legacy Desktop, Remote Connection source types
  • Quick Install and Track Existing flows
  • Snapshots — Auto and manual, restore/comparison
  • Model downloads — Built-in download manager
  • In-app terminal — Python environment access
  • Settings panels — Per-install ComfyUI Settings, Shared Directories, Global Settings
  • Data locations — Platform-specific paths (including XDG on Linux)
  • Troubleshooting — Common issues per platform

Notes

  • Desktop 2.0 is a complete rewrite from Desktop 1.0 — these docs are new content, not updates to the existing Desktop 1.0 docs
  • No screenshots included yet (will need actual app screenshots)
  • The doc structure is a separate installation/desktop-2/ path to coexist with the existing Desktop 1.0 docs

- Overview page explaining features and architecture
- Platform-specific install guides (Windows, macOS, Linux)
- Comprehensive usage guide covering the Chooser, installations, snapshots, model downloads, and settings
- Add Desktop 2.0 (Beta) section to navigation
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