Skip to content

Commit b87f5f7

Browse files
authored
(docs) Update redirect permanent param, clarify wording (#1332)
1 parent c2218a5 commit b87f5f7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

fern/snippets/redirects.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,15 @@ If your docs are hosted on a subpath (like `buildwithfern.com/learn`), include t
3030
</Info>
3131

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

3636
<ParamField path="destination" type="string" required={true}>
3737
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`.
3838
</ParamField>
3939

40-
<ParamField path="permanent" type="boolean" required={false}>
41-
`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.
40+
<ParamField path="permanent" type="boolean" required={false} default="true">
41+
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.
4242
</ParamField>
4343

4444
### Best practices

0 commit comments

Comments
 (0)