Skip to content

(docs) Update redirect permanent param, clarify wording #1332

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
merged 1 commit into from
Oct 20, 2025
Merged

(docs) Update redirect permanent param, clarify wording #1332

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions fern/snippets/redirects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@
</Info>

<ParamField path="source" type="string" required={true}>
The incoming request path pattern.
The path you want to redirect from.
</ParamField>

<ParamField path="destination" type="string" required={true}>
The path you want to route to. Can be an internal path (`/new-path`) or an external URL (`https://example.com`). External URLs must include the full address, including `https`.
</ParamField>

<ParamField path="permanent" type="boolean" required={false}>
`true` or `false` - default is `true`. If `true`, will use the 308 status code which instructs clients/search engines to cache the redirect forever. If `false`, will use the 307 status code which is temporary and is not cached.
<ParamField path="permanent" type="boolean" required={false} default="true">
By default, uses the 308 status code to instructs clients and search engines to cache the redirect forever. Set to `false` only if you need a temporary redirect using the 307 status code, which won't be cached.

Check warning on line 41 in fern/snippets/redirects.mdx

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[Microsoft.Passive] 'be cached' looks like passive voice.

Raw Output:
{"message": "[Microsoft.Passive] 'be cached' looks like passive voice.", "location": {"path": "fern/snippets/redirects.mdx", "range": {"start": {"line": 41, "column": 203}}}, "severity": "INFO"}
</ParamField>

### Best practices
Expand Down