Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,22 @@ Due to the necessity of adjusting article paths during documentation, changing t
> ```
> Don't forget to include the corresponding Chinese translation file in the `zh-CN` directory as well!

## About built-in node document

ComfyUI now has a built-in node help menu for both built-in nodes and custom nodes. All built-in node documentation will now be maintained in [this repo](https://github.com/Comfy-Org/embedded-docs).

### Synchronization frequency

We will regularly sync updated documentation from the corresponding repository to docs.comfy.org weekly to ensure content synchronization and updates. If you would like to contribute to the documentation, please submit PRs and updates to [this repo](https://github.com/Comfy-Org/embedded-docs).

### Node Documentation File Organization

For node documentation, we will use a single-level directory structure under the `built-in-node` folder for the following reasons:
- ComfyUI may adjust node categories and directories during updates, using multi-level directory hierarchies means frequent adjustments to node documentation
- These frequent adjustments mean we need to frequently add redirects and checks
- Mintlify supports setting document hierarchy in the `docs.json` file, so we can make unified changes in that file

> Due to historical updates, some existing documents use different folder hierarchies. We will no longer adjust these files, but new files will use a single-level directory

## Contributing

Expand Down
17 changes: 17 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,23 @@ npx @mintlify/scraping@latest openapi-file <path-to-openapi-file>
> ```
> 同时不要忘记在 `zh-CN` 目录中包含相应的中文翻译文件!

## 关于 ComfyUI 节点文档的更新说明

目前 ComfyUI 已经针对内置节点和自己定义节点等,都增加了内置的节点菜单,目前所有的节点文档将在[这个仓库](https://github.com/Comfy-Org/embedded-docs)进行维护

### 更新同步频率

我们会每周定期将已更新的文档从对应仓库中同步到 docs.comfy.org 中来,以保证内容同步和更新,如需贡献对应的文档,请在 [这个仓库](https://github.com/Comfy-Org/embedded-docs) 提交 PR 和更新。

### 节点文档文件组织

对于节点文档,我们将采用在 `built-in-node` 文件夹下使用一级目录的形式,以下是对应的原因:
- ComfyUI 可能会在更新过程中调整对应的节点分类和目录,使用多级目录层级意味着要对对应节点文档进行频繁调整
- 对应的频繁调整意味着我们需要频繁添加重定向和检查
- Mintlify 支持在 `docs.json` 文件设置文档层级,我们可以统一在这里进行修改

> 由于更新历史的原因,原有的一部分文档采用了不同的文件夹层级,目前我们不再对此部分文件进行调整,新增文件将采用一级目录

## 贡献

请直接创建 PR,我们会在几天内进行审核。
Expand Down