Skip to content

Update settings documentation to match frontend code#1037

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

Update settings documentation to match frontend code#1037
lin-bot23 wants to merge 9 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 and others added 9 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
HTML comments (<!-- -->) are not valid MDX, causing mint-checks to fail.
Use MDX comment syntax ({/* */}) instead.
Ref: PR Comfy-Org#1037 CI failure
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Settings documentation was updated across core, Desktop, server, 3D, LiteGraph, About, extension, overview, Japanese, and Chinese pages. The changes add current setting metadata, defaults, availability rules, interaction behavior, distribution-specific content, and localized references.

Changes

Settings documentation refresh

Layer / File(s) Summary
Settings navigation and availability
interface/settings/overview.mdx, ja/interface/settings/overview.mdx, zh/interface/settings/overview.mdx
Documents workspace-dependent menu structures, revised category cards, Desktop-only settings, and Cloud-only panels.
Core settings references
interface/settings/3d.mdx, interface/settings/comfy*.mdx, interface/settings/server-config.mdx, ja/interface/settings/comfy.mdx, zh/interface/settings/comfy.mdx
Updates 3D, Desktop, Comfy, and server setting options, defaults, metadata, validation, workflow behavior, and localized references.
LiteGraph interaction settings
interface/settings/lite-graph.mdx, ja/interface/settings/lite-graph.mdx, zh/interface/settings/lite-graph.mdx
Revises canvas navigation, node and group behavior, link actions, badges, pointer controls, and Nodes 2.0 documentation.
About and extension panels
interface/settings/about.mdx, interface/settings/extension.mdx, ja/interface/settings/about.mdx, zh/interface/settings/about.mdx
Adds distribution-specific badges, structured system information, copy behavior, update notifications, extension panel operations, and localized About content.
🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
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 PR with unit tests
⚔️ Resolve merge conflicts
  • Resolve merge conflict in branch update/settings-docs
✨ Simplify code
  • Create PR with simplified code

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@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.

Actionable comments posted: 7

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
interface/settings/overview.mdx (1)

30-119: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Replace em dashes across the changed English settings documentation.

  • interface/settings/overview.mdx#L30-L119: Use colons, commas, parentheses, or separate sentences in menu and availability descriptions.
  • interface/settings/comfy-desktop.mdx#L73-L86: Use colons between command names and their descriptions.

As per coding guidelines, “In English documentation, avoid em dashes (—).” <coding_guidelines>

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/overview.mdx` around lines 30 - 119, Replace every em dash
in interface/settings/overview.mdx lines 30-119 with appropriate colons, commas,
parentheses, or separate sentences in menu and availability descriptions. Also
update interface/settings/comfy-desktop.mdx lines 73-86, replacing em dashes
between command names and descriptions with colons; do not alter the documented
meaning.

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@interface/settings/about.mdx`:
- Around line 25-29: Align the Templates badge and system-info summary wording
so all locales consistently describe a version mismatch rather than using
“outdated” inconsistently. Update interface/settings/about.mdx lines 25-29 and
56, ja/interface/settings/about.mdx lines 27-31 and 58, and
zh/interface/settings/about.mdx lines 25-29 and 56, preserving each locale’s
language while keeping the English, Japanese, and Chinese descriptions
semantically in lockstep.

In `@interface/settings/extension.mdx`:
- Line 14: Resolve the TODO in the extension settings documentation by adding
the extension-panel screenshot at the indicated location, or replace it with a
tracked issue reference if the screenshot cannot be added now.
- Line 18: Update the documentation text around “Extension status changes” to
end the sentence with a period instead of a dangling colon, and replace all em
dashes in the referenced list sections with colons or separate sentences while
preserving the existing meaning.

In `@interface/settings/lite-graph.mdx`:
- Around line 172-177: Rewrite the two “Function” descriptions in the
link-release settings section using short, direct sentences. Clearly describe
the Shift-modified release action and the no-modifier release action separately,
avoiding stacked clauses and redundant wording while preserving their existing
behaviors.
- Around line 219-220: Align the tooltip delay documentation by changing the
stated range from 100–3000 to 0–3000 while preserving the note that 0 displays
tooltips immediately. Apply this update in interface/settings/lite-graph.mdx at
lines 219-220, ja/interface/settings/lite-graph.mdx at lines 215-218, and
zh/interface/settings/lite-graph.mdx at lines 217-218.

In `@interface/settings/server-config.mdx`:
- Line 206: Resolve the screenshot TODO in the server configuration
documentation by adding the required server config panel screenshot, or remove
the hidden TODO and create a tracked issue containing the screenshot
requirements for later completion.
- Line 129: Rewrite the Function description in the server configuration
reference using short, technical sentences that explicitly describe the
trade-off between preview quality and resource usage. Replace vague phrases such
as “performance consumption” and “find a balance” with concrete wording about
generation performance and system resources.

---

Outside diff comments:
In `@interface/settings/overview.mdx`:
- Around line 30-119: Replace every em dash in interface/settings/overview.mdx
lines 30-119 with appropriate colons, commas, parentheses, or separate sentences
in menu and availability descriptions. Also update
interface/settings/comfy-desktop.mdx lines 73-86, replacing em dashes between
command names and descriptions with colons; do not alter the documented meaning.
🪄 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: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 06a97f16-cd9c-4f88-aca1-d1ef78e11064

📥 Commits

Reviewing files that changed from the base of the PR and between 6c2c852 and c69fcee.

📒 Files selected for processing (16)
  • interface/settings/3d.mdx
  • interface/settings/about.mdx
  • interface/settings/comfy-desktop.mdx
  • interface/settings/comfy.mdx
  • interface/settings/extension.mdx
  • interface/settings/lite-graph.mdx
  • interface/settings/overview.mdx
  • interface/settings/server-config.mdx
  • ja/interface/settings/about.mdx
  • ja/interface/settings/comfy.mdx
  • ja/interface/settings/lite-graph.mdx
  • ja/interface/settings/overview.mdx
  • zh/interface/settings/about.mdx
  • zh/interface/settings/comfy.mdx
  • zh/interface/settings/lite-graph.mdx
  • zh/interface/settings/overview.mdx

Comment on lines +25 to +29
- **Templates Version**: If `systemStats.system.installed_templates_version` is available, a Templates badge is displayed:
- Label: `Templates v<version>`
- Link: [https://pypi.org/project/comfyui-workflow-templates/](https://pypi.org/project/comfyui-workflow-templates/)
- Icon: `pi pi-book`
- If the installed version differs from the required version, the badge appears with a **danger** severity level (red)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
fd -e ts -e tsx -e vue -e js |
  xargs rg -n -C3 \
    'installed_templates_version|required_templates_version|severity.*danger'

Repository: Comfy-Org/docs

Length of output: 156


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== Files with about.mdx ==\n'
git ls-files 'interface/settings/about.mdx' 'ja/interface/settings/about.mdx' 'zh/interface/settings/about.mdx' || true

printf '\n== Search for templates version references ==\n'
rg -n -C 3 'installed_templates_version|required_templates_version|Templates v|Templates バージョン|Templates 版本|severity.*danger|danger styling|outdated version' .

printf '\n== Search for likely implementation files by templates term ==\n'
rg -n -C 3 'templates' interface ja zh src app docs . | head -n 300

Repository: Comfy-Org/docs

Length of output: 33758


🌐 Web query:

ComfyUI frontend installed_templates_version required_templates_version Templates danger severity

💡 Result:

In ComfyUI, installed_templates_version and required_templates_version are system parameters used to manage the compatibility between the core ComfyUI application and the installed workflow templates package [1][2][3]. These fields are exposed via the /system_stats endpoint [2][3]. Their primary purpose is to allow the frontend to detect version mismatches [4]. When the installed version of the workflow templates does not meet the requirements defined in ComfyUI's requirements.txt, the system may trigger warnings or toast notifications to alert the user [2][4]. Regarding "danger" or "severity" levels: ComfyUI does not typically categorize these version mismatches with explicit "danger" or "severity" metadata levels (such as high, medium, or low) in its core code [1][3]. Instead, the system handles these as compatibility checks [4]: 1. Version Mismatch: If a mismatch is detected, the system generates logs and warnings [4]. Users often experience this as "missing node" errors, 404 errors when loading templates, or simply the disappearance of certain template options from the UI [5][6][7][8]. 2. Resolution: These issues are generally resolved by updating the comfyui-workflow-templates package in the user's Python environment (e.g., using pip install --upgrade comfyui-workflow-templates) or by ensuring both ComfyUI and the manager are up to date [8][9]. While there is no formal severity scale, a version mismatch is functionally critical for specific features; if the templates are outdated, the associated workflows or nodes will often fail to execute or load, rendering those specific features non-functional [5][6][8].

Citations:


Keep the Templates danger wording consistent across locales. The badge text uses a version mismatch, but the system-info summary says only “outdated.” Keep the English, Japanese, and Chinese pages in lockstep so the docs don’t turn into a mismatch mishmash.

📍 Affects 3 files
  • interface/settings/about.mdx#L25-L29 (this comment)
  • interface/settings/about.mdx#L56-L56
  • ja/interface/settings/about.mdx#L27-L31
  • ja/interface/settings/about.mdx#L58-L58
  • zh/interface/settings/about.mdx#L25-L29
  • zh/interface/settings/about.mdx#L56-L56
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/about.mdx` around lines 25 - 29, Align the Templates badge
and system-info summary wording so all locales consistently describe a version
mismatch rather than using “outdated” inconsistently. Update
interface/settings/about.mdx lines 25-29 and 56, ja/interface/settings/about.mdx
lines 27-31 and 58, and zh/interface/settings/about.mdx lines 25-29 and 56,
preserving each locale’s language while keeping the English, Japanese, and
Chinese descriptions semantically in lockstep.

The Extension settings panel is a special management panel in the ComfyUI frontend settings system, specifically used to manage the enable/disable status of frontend extension plugins. Unlike Custom Nodes, this panel is only used to manage frontend extensions registered by custom nodes, not to disable custom nodes themselves.

![extension](/images/interface/setting/extension/extension.jpg)
{/* TODO: Add screenshot of the extension panel */}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🔵 Trivial

Complete or track the missing extension-panel screenshot.

This TODO leaves the visual documentation unfinished. Would you like me to help draft an issue for the screenshot?

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/extension.mdx` at line 14, Resolve the TODO in the
extension settings documentation by adding the extension-panel screenshot at the
indicated location, or replace it with a tracked issue reference if the
screenshot cannot be added now.


These frontend extension plugins are used to enhance the ComfyUI experience, such as providing shortcuts, settings, UI components, menu items, and other features.

Extension status changes require a page reload to take effect:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Dash the em dashes and fix the dangling colon.

Use a period on Line 18. Replace the em dashes with colons or separate sentences throughout these lists.

As per coding guidelines, “In English documentation in MDX, avoid em dashes (—).” <coding_guidelines>

Also applies to: 24-26, 31-31, 43-48, 52-53

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/extension.mdx` at line 18, Update the documentation text
around “Extension status changes” to end the sentence with a period instead of a
dangling colon, and replace all em dashes in the referenced list sections with
colons or separate sentences while preserving the existing meaning.

Source: Coding guidelines

Comment on lines 172 to 177
- **Function**: Sets the action when releasing links while holding the Shift key, special behavior when releasing links while holding Shift

### Action on link release (No modifier)
- **Default Value**: context menu
- **Options**: context menu, search box, no action
- **Default Value**: context menu
- **Function**: Sets the default action when releasing links, controls the behavior after dragging and releasing links

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use direct descriptions for both release actions.

Proposed rewrite
-**Function**: Sets the action when releasing links while holding the Shift key, special behavior when releasing links while holding Shift
+**Function**: Sets the action when a link is released while holding `Shift`.
 
-**Function**: Sets the default action when releasing links, controls the behavior after dragging and releasing links
+**Function**: Sets the action when a link is released without a modifier key.

As per coding guidelines, “prefer short, direct sentences over stacked clauses” in English documentation.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Function**: Sets the action when releasing links while holding the Shift key, special behavior when releasing links while holding Shift
### Action on link release (No modifier)
- **Default Value**: context menu
- **Options**: context menu, search box, no action
- **Default Value**: context menu
- **Function**: Sets the default action when releasing links, controls the behavior after dragging and releasing links
- **Function**: Sets the action when releasing links while holding the Shift key, special behavior when releasing links while holding Shift
### Action on link release (No modifier)
- **Options**: context menu, search box, no action
- **Default Value**: context menu
- **Function**: Sets the action when a link is released without a modifier key.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/lite-graph.mdx` around lines 172 - 177, Rewrite the two
“Function” descriptions in the link-release settings section using short, direct
sentences. Clearly describe the Shift-modified release action and the
no-modifier release action separately, avoiding stacked clauses and redundant
wording while preserving their existing behaviors.

Source: Coding guidelines

Comment on lines +219 to 220
- **Range**: 100 - 3000
- **Function**: Controls the delay time for tooltips, in milliseconds. Setting to 0 means displaying tooltips immediately

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== English locale excerpt ==\n'
sed -n '210,228p' interface/settings/lite-graph.mdx

printf '\n== Japanese locale excerpt ==\n'
sed -n '208,224p' ja/interface/settings/lite-graph.mdx

printf '\n== Chinese locale excerpt ==\n'
sed -n '210,224p' zh/interface/settings/lite-graph.mdx

printf '\n== Search for tooltip delay references ==\n'
rg -n "tooltip delay|ツールチップ遅延|工具提示的延迟|delay time for tooltips|0 means displaying tooltips immediately|0 に設定すると|设置为0表示立即显示" -S .

Repository: Comfy-Org/docs

Length of output: 2759


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== Search for setting key and validation ==\n'
rg -n "tooltip.*delay|ツールチップ遅延|工具提示.*延迟|delay.*tooltip|min.*100|max.*3000|0.*tooltip|tooltip.*0" -S interface ja zh . || true

printf '\n== Candidate files mentioning tooltip or graph settings ==\n'
git ls-files | rg '(^|/)(interface|ja|zh)/.*lite-graph|(^|/).*tooltip|(^|/)settings/.*graph|(^|/)graph.*(ts|tsx|js|jsx|mdx)$' -n

Repository: Comfy-Org/docs

Length of output: 47088


Align the tooltip delay docs with the zero-delay behavior. interface/settings/lite-graph.mdx, ja/interface/settings/lite-graph.mdx, and zh/interface/settings/lite-graph.mdx say 0 shows tooltips immediately, but the stated range starts at 100. Either include 0 in the range or remove the zero-delay note. Small mismatch, big tooltip tangle.

📍 Affects 3 files
  • interface/settings/lite-graph.mdx#L219-L220 (this comment)
  • ja/interface/settings/lite-graph.mdx#L215-L218
  • zh/interface/settings/lite-graph.mdx#L217-L218
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/lite-graph.mdx` around lines 219 - 220, Align the tooltip
delay documentation by changing the stated range from 100–3000 to 0–3000 while
preserving the note that 0 displays tooltips immediately. Apply this update in
interface/settings/lite-graph.mdx at lines 219-220,
ja/interface/settings/lite-graph.mdx at lines 215-218, and
zh/interface/settings/lite-graph.mdx at lines 217-218.

- `latent2rgb`: Directly converts latent space data to RGB images for preview, faster but average quality
- `taesd`: Uses lightweight TAESD model for preview, balances speed and quality

**Function**: Controls how to preview intermediate results during generation. Different preview methods affect preview quality and performance consumption. Choosing the right preview method can find a balance between preview effects and system resource usage.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Describe the preview trade-off directly.

“Performance consumption” and “find a balance between preview effects” are vague. Use technical, concrete wording.

Proposed rewrite
-**Function**: Controls how to preview intermediate results during generation. Different preview methods affect preview quality and performance consumption. Choosing the right preview method can find a balance between preview effects and system resource usage.
+**Function**: Controls intermediate previews during generation. Preview methods trade image quality against compute and VRAM usage.

As per coding guidelines, “prefer short, direct sentences” and match a “technical reference rather than marketing blog” tone.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**Function**: Controls how to preview intermediate results during generation. Different preview methods affect preview quality and performance consumption. Choosing the right preview method can find a balance between preview effects and system resource usage.
**Function**: Controls intermediate previews during generation. Preview methods trade image quality against compute and VRAM usage.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/server-config.mdx` at line 129, Rewrite the Function
description in the server configuration reference using short, technical
sentences that explicitly describe the trade-off between preview quality and
resource usage. Replace vague phrases such as “performance consumption” and
“find a balance” with concrete wording about generation performance and system
resources.

Source: Coding guidelines


**Note**: Requires a restart to take effect.

<!-- TODO: Add screenshot of the server config panel -->

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🔵 Trivial

Resolve or track the screenshot TODO.

Add the screenshot or move this task to the issue tracker before the hidden TODO becomes permanent. Would you like me to draft the screenshot requirements?

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@interface/settings/server-config.mdx` at line 206, Resolve the screenshot
TODO in the server configuration documentation by adding the required server
config panel screenshot, or remove the hidden TODO and create a tracked issue
containing the screenshot requirements for later completion.

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