Skip to content

Commit d0e3d76

Browse files
Update README.md (#561)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 8b3df4c commit d0e3d76

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,11 @@ 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 File Save Locations
30+
## Special Note on renaming files
3131

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`
3635

3736
> **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:
3837
> ```json

0 commit comments

Comments
 (0)