Skip to content

Commit 31926e5

Browse files
authored
Update README
1 parent d0e3d76 commit 31926e5

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,14 @@ npx @mintlify/scraping@latest openapi-file <path-to-openapi-file>
2727
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.
2828

2929

30-
## Special Note on renaming files
30+
## Special Note on Renaming Files
3131

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:
3537

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:
3738
> ```json
3839
> "redirects": [
3940
> {
@@ -44,6 +45,8 @@ This will only generate the MDX files for each endpoint. You need to add a link
4445
> ```
4546
> Don't forget to include the corresponding Chinese translation file in the `zh-CN` directory as well!
4647
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+
4750
## About built-in node document
4851
4952
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

Comments
 (0)