Skip to content

(docs) Update redirects page with info on hide-404-page setting #1224

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 2 commits into from
Oct 12, 2025
Merged

(docs) Update redirects page with info on hide-404-page setting #1224

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
79e3e08
update redirects page
devalog Oct 11, 2025
872e80c
small fix
devalog Oct 11, 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
14 changes: 7 additions & 7 deletions fern/products/docs/pages/customization/what-is-docs-yml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -468,31 +468,31 @@ settings:
The text to display in the searchbar.
</ParamField>

<ParamField path="settings.disable-search" type="boolean" required={false}>
<ParamField path="settings.disable-search" type="boolean" required={false} default="false">
If set to true, the searchbar will be disabled. Use this if you want to use a custom search solution.
</ParamField>

<ParamField path="settings.dark-mode-code" type="boolean" required={false}>
<ParamField path="settings.dark-mode-code" type="boolean" required={false} default="false">
If set to true, the code blocks will be displayed in dark mode, regardless of the selected theme.
</ParamField>

<ParamField path="settings.default-search-filters" type="boolean" required={false}>
By default, search will display results for pages across all products and versions.
<ParamField path="settings.default-search-filters" type="boolean" required={false} default="false">
By default (`false`), search will display results for pages across all products and versions.

If set to true, search will display results for pages within the current product and version.
</ParamField>

<ParamField path="settings.http-snippets" type="boolean" required={false}>
<ParamField path="settings.http-snippets" type="boolean" required={false} default="false">
If set to true, the HTTP snippets will be displayed in the API Reference.
</ParamField>

<ParamField path="settings.hide-404-page" type="boolean" required={false}>
<ParamField path="settings.hide-404-page" type="boolean" required={false} default="false">
If set to true, when a user navigates to a page that does not exist, they will be redirected to the home page.

By default, a 404 page will be displayed.
</ParamField>

<ParamField path="settings.use-javascript-as-typescript" type="boolean" required={false}>
<ParamField path="settings.use-javascript-as-typescript" type="boolean" required={false} default="false">
If set to true, the TypeScript snippets will be displayed as JavaScript snippets in the API Reference.
</ParamField>

Expand Down
7 changes: 6 additions & 1 deletion fern/snippets/redirects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,12 @@ redirects:
destination: / # Don't do this
```

Instead, reach out to Fern to enable automatic homepage redirects, an internal setting that handles broken links without needing manual redirects.
Instead, [enable automatic homepage redirects in your `docs.yml`](/docs/configuration/what-is-docs-yml#settings-configuration) to send broken links to your homepage rather than showing a 404 page:

```yaml title="docs.yml"
settings:
hide-404-page: true
```

</Accordion>
<Accordion title="Versioning and redirects">
Expand Down