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 File Save Locations
30
+
## Special Note on renaming files
31
31
32
-
Due to the necessity of adjusting article paths during documentation, changing these paths might render original links inaccessible, as they are already used in numerous articles and templates.
33
-
- Since the organization of the document directory can be reorganized through the `docs.json` file, we generally do not change the original document's file location unless absolutely necessary.
34
-
- If adjustments are needed, please modify `docs.json` to reorganize the files.
35
-
- If changes are essential, please add redirection rules in the `docs.json` file.
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`
36
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:
0 commit comments