You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This will only generate the MDX files for each endpoint. You need to add a link to these files in `docs.json`, and the up-to-date API spec will be shown on that doc page.
28
28
29
29
30
-
## Special Note on renaming files
30
+
## Special Note on Renaming Files
31
31
32
-
• Renaming files can cause some external links to become inaccessible, as they are already used in numerous articles and templates.
33
-
• Since we can manage the sidebar navigation can be reorganized via the docs.json file, we generally do not change the original document's file location unless absolutely necessary.
34
-
• If you renamed any files and caused the file path to be changed, please update the `redirects` list in the `docs.json`
32
+
- Renaming files can cause some external links to become inaccessible, as they are already used in numerous articles and templates.
33
+
- Since we can manage the sidebar navigation can be reorganized via the docs.json file, we generally do not change the original document's file location unless absolutely necessary.
34
+
- If you renamed any files and caused the file path to be changed, please update the `redirects` list in the `docs.json`
35
+
36
+
A GitHub Action will check for redirects and fail the PR if they are missing. Redirects should follow this format:
35
37
36
-
> **Important**: When you move or rename an MDX file, you MUST add a redirect in the `docs.json` file. A GitHub Action will check for redirects and fail the PR if they are missing. Redirects should follow this format:
37
38
> ```json
38
39
> "redirects": [
39
40
> {
@@ -44,6 +45,8 @@ This will only generate the MDX files for each endpoint. You need to add a link
44
45
> ```
45
46
> Don't forget to include the corresponding Chinese translation file in the `zh-CN` directory as well!
46
47
48
+
You can also refer to the [Mintlify doc](https://www.mintlify.com/docs/create/redirects) to learn how to add and match a wildcard path.
49
+
47
50
## About built-in node document
48
51
49
52
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).
0 commit comments