From aa76b49fa85d443e8fd8826191eddaace08887ed Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:27:01 +0000 Subject: [PATCH 1/7] Update custom-nodes/help_page.mdx --- custom-nodes/help_page.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/custom-nodes/help_page.mdx b/custom-nodes/help_page.mdx index 95df126f..76686a75 100644 --- a/custom-nodes/help_page.mdx +++ b/custom-nodes/help_page.mdx @@ -1,11 +1,11 @@ --- -title: "Help Page" -description: "How to create rich documentation for your custom nodes" +title: "Built-in Node Docs" +description: "How to create rich documentation for your built-in nodes" --- ## Node Documentation with Markdown -Custom nodes can include rich markdown documentation that will be displayed in the UI instead of the generic node description. This provides users with detailed information about your node's functionality, parameters, and usage examples. +Built-in nodes can include rich markdown documentation that will be displayed in the UI instead of the generic node description. This provides users with detailed information about your node's functionality, parameters, and usage examples. If you have already added tooltips for each parameter in the node definition, this basic information can be directly accessed via the node documentation panel. No additional node documentation needs to be added, and you can refer to the related implementation of [ContextWindowsManualNode](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy_extras/nodes_context_windows.py#L7) From 509f0719863bbd04c5b275ff9af369434cc22d18 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:27:08 +0000 Subject: [PATCH 2/7] Update custom-nodes/help_page.mdx --- custom-nodes/help_page.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/custom-nodes/help_page.mdx b/custom-nodes/help_page.mdx index 76686a75..3ed928bb 100644 --- a/custom-nodes/help_page.mdx +++ b/custom-nodes/help_page.mdx @@ -12,7 +12,7 @@ No additional node documentation needs to be added, and you can refer to the rel ## Setup -To add documentation for your nodes or multi-language support documentation: +To add documentation for your built-in nodes or multi-language support documentation: 1. Create a `docs` folder inside your `WEB_DIRECTORY` 2. Add markdown files named after your nodes (the names of your nodes are the dictionary keys in the `NODE_CLASS_MAPPINGS` dictionary used to register the nodes): From 0ef565f5b33df99750ece8c397400bc3ba0f5515 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:28:55 +0000 Subject: [PATCH 3/7] Update zh-CN/custom-nodes/help_page.mdx --- zh-CN/custom-nodes/help_page.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/zh-CN/custom-nodes/help_page.mdx b/zh-CN/custom-nodes/help_page.mdx index 5b6f538f..9fcb2821 100644 --- a/zh-CN/custom-nodes/help_page.mdx +++ b/zh-CN/custom-nodes/help_page.mdx @@ -1,17 +1,17 @@ --- -title: "帮助页面" -description: "如何为自定义节点创建帮助文档" +title: "内置节点文档" +description: "如何为内置节点创建帮助文档" --- ## 使用 Markdown 创建节点文档 -自定义节点可以使用 Markdown 来创建富文本文档，这些文档信息将在 UI 中显示，取代常见的节点描述信息。可以为用户提供关于节点功能、参数和使用示例的详细信息。 +内置节点可以使用 Markdown 来创建富文本文档，这些文档信息将在 UI 中显示，取代常见的节点描述信息。可以为用户提供关于节点功能、参数和使用示例的详细信息。 如果你在节点的相关描述信息中已经添加的每个参数的说明信息（tooltip），那么这些基础信息可以被节点文档面板直接获取，而无需再额外添加节点文档，你可以参考 [ContextWindowsManualNode](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy_extras/nodes_context_windows.py#L7) 的相关实现。 ## 设置 -为你的节点添加节点文档或多语言支持的节点文档： +为你的内置节点添加节点文档或多语言支持的节点文档： 1. 在你的 `WEB_DIRECTORY` 中创建 `docs` 文件夹 2. 添加以节点名称命名的 Markdown 文件（您的节点名称是用于注册节点的 `NODE_CLASS_MAPPINGS` 字典中的字典键）： From f67041b7a159ab1095081fa493b936106b913b8f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:30:35 +0000 Subject: [PATCH 4/7] Update custom-nodes/help_page.mdx --- custom-nodes/help_page.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/custom-nodes/help_page.mdx b/custom-nodes/help_page.mdx index 3ed928bb..4ced80be 100644 --- a/custom-nodes/help_page.mdx +++ b/custom-nodes/help_page.mdx @@ -1,5 +1,6 @@ --- -title: "Built-in Node Docs" +title: "Add node docs for your ComfyUI custom node" +sidebarTitle: "Node docs" description: "How to create rich documentation for your built-in nodes" --- From 80b04df4e2bc480cec1891aae95613e58e1fe88c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:30:45 +0000 Subject: [PATCH 5/7] Update zh-CN/custom-nodes/help_page.mdx --- zh-CN/custom-nodes/help_page.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/zh-CN/custom-nodes/help_page.mdx b/zh-CN/custom-nodes/help_page.mdx index 9fcb2821..7880e0f0 100644 --- a/zh-CN/custom-nodes/help_page.mdx +++ b/zh-CN/custom-nodes/help_page.mdx @@ -1,5 +1,6 @@ --- -title: "内置节点文档" +title: "为你的 ComfyUI 自定义节点添加节点文档" +sidebarTitle: "节点文档" description: "如何为内置节点创建帮助文档" --- From ac0f1d77753c90538c9d0efc584ba59c216e26a4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 17 Nov 2025 16:32:51 +0000 Subject: [PATCH 6/7] Update custom-nodes/help_page.mdx --- custom-nodes/help_page.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/custom-nodes/help_page.mdx b/custom-nodes/help_page.mdx index 4ced80be..5a6b72e5 100644 --- a/custom-nodes/help_page.mdx +++ b/custom-nodes/help_page.mdx @@ -1,19 +1,19 @@ --- title: "Add node docs for your ComfyUI custom node" sidebarTitle: "Node docs" -description: "How to create rich documentation for your built-in nodes" +description: "How to create rich documentation for your custom nodes" --- ## Node Documentation with Markdown -Built-in nodes can include rich markdown documentation that will be displayed in the UI instead of the generic node description. This provides users with detailed information about your node's functionality, parameters, and usage examples. +Custom nodes can include rich markdown documentation that will be displayed in the UI instead of the generic node description. This provides users with detailed information about your node's functionality, parameters, and usage examples. If you have already added tooltips for each parameter in the node definition, this basic information can be directly accessed via the node documentation panel. No additional node documentation needs to be added, and you can refer to the related implementation of [ContextWindowsManualNode](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy_extras/nodes_context_windows.py#L7) ## Setup -To add documentation for your built-in nodes or multi-language support documentation: +To add documentation for your custom nodes or multi-language support documentation: 1. Create a `docs` folder inside your `WEB_DIRECTORY` 2. Add markdown files named after your nodes (the names of your nodes are the dictionary keys in the `NODE_CLASS_MAPPINGS` dictionary used to register the nodes): From 7c725d41df665e5e013db5a5892c65976b59097c Mon Sep 17 00:00:00 2001 From: ComfyUI Wiki Date: Tue, 18 Nov 2025 00:37:02 +0800 Subject: [PATCH 7/7] Update help page to reference custom nodes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replaced references to '内置节点' (built-in nodes) with '自定义节点' (custom nodes) to clarify documentation applies to custom node development. This improves accuracy for users creating help docs for their own nodes. --- zh-CN/custom-nodes/help_page.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh-CN/custom-nodes/help_page.mdx b/zh-CN/custom-nodes/help_page.mdx index 7880e0f0..eb508c22 100644 --- a/zh-CN/custom-nodes/help_page.mdx +++ b/zh-CN/custom-nodes/help_page.mdx @@ -6,13 +6,13 @@ description: "如何为内置节点创建帮助文档" ## 使用 Markdown 创建节点文档 -内置节点可以使用 Markdown 来创建富文本文档，这些文档信息将在 UI 中显示，取代常见的节点描述信息。可以为用户提供关于节点功能、参数和使用示例的详细信息。 +自定义节点可以使用 Markdown 来创建富文本文档，这些文档信息将在 UI 中显示，取代常见的节点描述信息。可以为用户提供关于节点功能、参数和使用示例的详细信息。 如果你在节点的相关描述信息中已经添加的每个参数的说明信息（tooltip），那么这些基础信息可以被节点文档面板直接获取，而无需再额外添加节点文档，你可以参考 [ContextWindowsManualNode](https://github.com/comfyanonymous/ComfyUI/blob/master/comfy_extras/nodes_context_windows.py#L7) 的相关实现。 ## 设置 -为你的内置节点添加节点文档或多语言支持的节点文档： +为你的自定义节点添加节点文档或多语言支持的节点文档： 1. 在你的 `WEB_DIRECTORY` 中创建 `docs` 文件夹 2. 添加以节点名称命名的 Markdown 文件（您的节点名称是用于注册节点的 `NODE_CLASS_MAPPINGS` 字典中的字典键）：