Skip to content

Update settings documentation to match frontend code#1037

Open
lin-bot23 wants to merge 5 commits into
Comfy-Org:mainfrom
lin-bot23:update/settings-docs
Open

Update settings documentation to match frontend code#1037
lin-bot23 wants to merge 5 commits into
Comfy-Org:mainfrom
lin-bot23:update/settings-docs

Conversation

@lin-bot23
Copy link
Copy Markdown
Contributor

Summary

Syncs the Comfy and LiteGraph settings documentation pages with the actual settings defined in ComfyUI_frontend/src/platform/settings/constants/coreSettings.ts.

After this PR, the docs (89 settings) closely match the frontend (91 visible settings). The 2 not in docs are float rounding settings where the frontend name includes a trailing period, and the 7 other missing ones (sidebar, opacity, background image, etc.) are already covered by appearance.mdx.

Changes to comfy.mdx

Removed/Obsolute

  • Bottom option from Use new menu (only Top/Disabled remain)
  • Topbar (Second Row) from Opened workflows position

Fixed values

  • Queue history size default: 10064
  • Validate workflows default: EnabledDisabled
  • Node search implementation options: now lists default | v1 (legacy) | litegraph (legacy)
  • Ctrl+up/down precision default: 0.010.05

Added sections

  • Disable animations
  • Tab Bar Layout
  • Show errors tab in side panel
  • Live preview method
  • Show version updates
  • Enable node replacement suggestions
  • Always show advanced widgets on all nodes
  • New Node Library Design
  • Added nodes follow the cursor
  • Docked job history/queue panel
  • Require confirmation to overwrite subgraph blueprint
  • Textarea widget font size

Updated

  • Show missing nodes warning now notes it's superseded by node replacement suggestions
  • Widget control mode default corrected to after
  • Node Search Box section notes which options apply to which implementation

Changes to lite-graph.mdx

Replaced

  • Deprecated Low quality rendering zoom thresholdZoom Node Level of Detail - font size threshold

Fixed values

  • Always shrink new nodes default: EnabledDisabled
  • Scale node combo widget menus default: EnabledDisabled
  • Node source badge mode default: Show allHide built-in
  • Node ID badge mode default: Show allNone
  • Pointer click drift delay default: 15032
  • Various range constraints added/updated

Added sections

  • Navigation Mode (Standard / Drag Navigation / Custom)
  • Left Mouse Click Behavior
  • Mouse Wheel Scroll
  • Auto-pan speed
  • Live selection
  • Enable trackpad gestures (now integrated with navigation mode)
  • Select group children on click
  • Modern Node Design (Nodes 2.0)
  • Auto-scale layout (Nodes 2.0)
  • Pointer click drift (maximum distance)

Updated

  • Pointer section rewritten with accurate experimental flags and precise ranges
  • Tooltip descriptions refined for clarity

lin-bot23 added 5 commits May 27, 2026 00:32
Syncs the Comfy and LiteGraph settings documentation with the actual
settings defined in ComfyUI_frontend/src/platform/settings/constants/coreSettings.ts.

Changes to comfy.mdx:
- Removed: 'Bottom' option from Use new menu (only Top/Disabled remain)
- Removed: 'Topbar (Second Row)' from Opened workflows position
- Fixed: Queue history size default from 100 to 64
- Fixed: Validate workflows default from Enabled to Disabled
- Fixed: Node search box implementation options (v1/litegraph legacy)
- Fixed: Ctrl+up/down precision default from 0.01 to 0.05
- Fixed: 'Show missing nodes warning' moved under node replacement
- Added: Disable animations
- Added: Tab Bar Layout
- Added: Show errors tab in side panel
- Added: Live preview method
- Added: Show version updates
- Added: Enable node replacement suggestions
- Added: Always show advanced widgets on all nodes
- Added: New Node Library Design
- Added: Added nodes follow the cursor
- Added: Docked job history/queue panel
- Added: Require confirmation to overwrite subgraph blueprint
- Added: Textarea widget font size
- Added: Auto-pan speed
- Updated: Node Search Box section to clarify which options apply to which implementation

Changes to lite-graph.mdx:
- Replaced: deprecated 'Low quality rendering zoom threshold' with 'Zoom Node LOD'
- Fixed: 'Always shrink new nodes' default from Enabled to Disabled
- Fixed: 'Scale context menus' default from Enabled to Disabled
- Fixed: Node source badge mode default from 'Show all' to 'Hide built-in'
- Fixed: Node ID badge mode default from 'Show all' to 'None'
- Fixed: Pointer click drift delay default from 150 to 32
- Added: Navigation Mode (Standard/Legacy/Custom)
- Added: Left Mouse Click Behavior
- Added: Mouse Wheel Scroll
- Added: Auto-pan speed
- Added: Live selection
- Added: Enable trackpad gestures (now integrated with navigation mode)
- Added: Select group children on click
- Added: Modern Node Design (Nodes 2.0)
- Added: Auto-scale layout (Nodes 2.0)
- Updated: Pointer section with precise ranges and experimental flags
- Updated: Various default values, tooltips, and descriptions
Syncs Chinese and Japanese translations of interface/settings/comfy.mdx
and lite-graph.mdx with the updated English versions. Key changes:

- Remove deprecated 'Bottom' menu option and 'Topbar (Second Row)'
- Replace deprecated 'Low quality rendering zoom threshold' with 'Zoom Node LOD'
- Fix default values: queue history 100->64, validate workflows Enabled->Disabled,
  Ctrl+precision 0.01->0.05, various LiteGraph defaults
- Add missing settings section: navigation mode, left mouse click behavior,
  mouse wheel scroll, live preview, auto-pan, node replacement suggestions,
  docked queue panel, modern node design, animations, and more
- Update Node Search Box with per-implementation notes
- Fix default values for litegraph settings (scale menus, new node shrink,
  node ID/source badges, pointer drift delay, etc.)
The frontend defines 12 supported locales, not 7. Adds:
- 繁體中文 (Traditional Chinese / zh-TW)
- Português (BR / pt-BR)
- Türkçe (Turkish / tr)
- عربي (Arabic / ar)
- فارسی (Persian / fa)
…-config)

Based on audit reports comparing docs against frontend source code.

3d.mdx:
- Remove 'Initial Preview Visibility' (doesn't exist in frontend)
- Add 'Enable 3D Viewer (Beta)' and 'PLY Engine' settings

about.mdx:
- Detail 3 version badge formats (OSS/Desktop/Cloud)
- Add Templates version badge with danger styling
- Fix badge order and label names (ComfyOrg not 'Official Website')
- Detail System Info columns per distribution
- Add Devices tab section and Copy System Info button
- Add version update notifications section

extension.mdx:
- Replace broken image with TODO placeholder
- Add extension filter section (All/Core/Custom)
- Add multi-selection checkbox column
- Right-click menu from 3 to 6 entries
- Add change notification with [+]/[-] markers

server-config.mdx:
- Fix preview method default (none, not auto)
- Add gpu-only to VRAM options
- Add preview size range/default
- Add enable-manager-legacy-ui setting
- Add screenshot TODO placeholder
overview.mdx:
- Rewrite to reflect actual 3-layer sidebar structure instead of 12 flat cards
- Document workspace/legacy mode differences
- Add Desktop-only and Cloud-only sections
- Group setting cards under proper categories

comfy-desktop.mdx:
- Add setting IDs, types, defaults for all 6 Desktop settings
- Document Window Style custom option functionality
- Move UV mirror section from 'UV' to 'UV (Mirror Settings)'
- Add tooltip details for each mirror setting
- Add Available Commands section (folders, app commands)
- Document validation behavior for URL-type settings
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