Skip to content

Add warning about infinite redirect loops in redirects documentation #2429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ruhanponnada merged 2 commits into from
Dec 18, 2025
Merged

Add warning about infinite redirect loops in redirects documentation #2429

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4163203
Update create/redirects.mdx
ruhanponnada Dec 18, 2025
8a726a8
Update warning message for redirect rules
ruhanponnada Dec 18, 2025
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
10 changes: 10 additions & 0 deletions create/redirects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
]
```

This permanently redirects `/source/path` to `/destination/path` so that you don't lose any previous SEO for the original page.

Check warning on line 22 in create/redirects.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/redirects.mdx#L22 

Spell out 'SEO', if it's unfamiliar to the audience.

To match a wildcard path, use `*` after a parameter. In this example, `/beta/:slug*` matches `/beta/introduction` and redirects it to `/v2/introduction`.

Expand All @@ -32,12 +32,22 @@
]
```

<Warning>
The destination slug cannot match to the source slug. For example, if your docs are hosted at `/docs`, avoid:

Check warning on line 36 in create/redirects.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/redirects.mdx#L36 

Use 'can't' instead of 'cannot'.

Check warning on line 36 in create/redirects.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/redirects.mdx#L36 

In general, use active voice instead of passive voice ('are hosted').
```json
{
"source": "/docs/:slug*",
"destination": "/:slug*"
}
```
</Warning>

## Broken links

Catch broken links with our CLI. [Install the CLI](/installation) and run the command:

Check warning on line 47 in create/redirects.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/redirects.mdx#L47 

Try to avoid using first-person plural like 'our'.

Check warning on line 47 in create/redirects.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/redirects.mdx#L47 

Use 'command-line tool' instead of 'CLI'.

```bash
mint broken-links
```

The CLI identifies any relative links in your docs that don't exist.

Check warning on line 53 in create/redirects.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/redirects.mdx#L53 

Use 'command-line tool' instead of 'CLI'.