Update settings documentation to match frontend code#1037
Open
lin-bot23 wants to merge 5 commits into
Open
Conversation
lin-bot23
added a commit
to lin-bot23/docs
that referenced
this pull request
Jul 15, 2026
HTML comments (<!-- -->) are not valid MDX, causing mint-checks to fail.
Use MDX comment syntax ({/* */}) instead.
Ref: PR Comfy-Org#1037 CI failure
|
Important Review skippedToo many files! This PR contains 2890 files, which is 2790 over the limit of 100. To get a review, narrow the scope: Upgrade to a paid plan to raise the limit. Usage-priced reviews support at most 300 files. ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (81)
📒 Files selected for processing (2919)
You can disable this status message by setting the 📝 WalkthroughWalkthroughSettings 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. ChangesSettings documentation refresh
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 winReplace 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
📒 Files selected for processing (16)
interface/settings/3d.mdxinterface/settings/about.mdxinterface/settings/comfy-desktop.mdxinterface/settings/comfy.mdxinterface/settings/extension.mdxinterface/settings/lite-graph.mdxinterface/settings/overview.mdxinterface/settings/server-config.mdxja/interface/settings/about.mdxja/interface/settings/comfy.mdxja/interface/settings/lite-graph.mdxja/interface/settings/overview.mdxzh/interface/settings/about.mdxzh/interface/settings/comfy.mdxzh/interface/settings/lite-graph.mdxzh/interface/settings/overview.mdx
| 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. | ||
|
|
||
|  | ||
| {/* TODO: Add screenshot of the extension panel */} |
There was a problem hiding this comment.
📐 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: |
There was a problem hiding this comment.
📐 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 |
There was a problem hiding this comment.
📐 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 |
There was a problem hiding this comment.
🎯 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)$' -nRepository: 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-L218zh/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.
Align Comfy and LiteGraph settings documentation with latest ComfyUI_frontend/src/platform/settings/constants/coreSettings.ts. Covers EN/ZH/JA translations.
lin-bot23
force-pushed
the
update/settings-docs
branch
from
July 24, 2026 14:46
413fecc to
8dd57bb
Compare
…ures, add ko translations - Add 'Experimental: Yes' flag to Node search box implementation and Show missing models warning (matches coreSettings.ts) - Clarify Enable trackpad gestures is derived from Navigation Mode - Add Korean (ko) translations for all 6 settings files - Apply same fixes to zh/ja/ko translations
…erminology - Remove 'Show missing nodes warning' (not a real configurable setting) - Fix broken image: canvas-menu.jpg -> canvas_menu.jpg (EN+KO) - Fix KO anchor links: English anchors -> Korean heading anchors - Fix KO typo: 기준값 -> 기본값 - Replace em-dashes with colons in list items (EN/KO/JA/ZH overview + extension) - Update JA/ZH: API Nodes -> Partner Nodes terminology
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
1 participant
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
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.mdxRemoved/Obsolute
Use new menu(only Top/Disabled remain)Opened workflows positionFixed values
100→64Enabled→Disableddefault | v1 (legacy) | litegraph (legacy)0.01→0.05Added sections
Updated
Show missing nodes warningnow notes it's superseded by node replacement suggestionsafterChanges to
lite-graph.mdxReplaced
Low quality rendering zoom threshold→Zoom Node Level of Detail - font size thresholdFixed values
Enabled→DisabledEnabled→DisabledShow all→Hide built-inShow all→None150→32Added sections
Updated