Skip to content

Commit e31825f

Browse files
authored
(docs) Update redirects page with info on hide-404-page setting (#1224)
1 parent d2f8bfc commit e31825f

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

fern/products/docs/pages/customization/what-is-docs-yml.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -468,31 +468,31 @@ settings:
468468
The text to display in the searchbar.
469469
</ParamField>
470470

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

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

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

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

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

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

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

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

fern/snippets/redirects.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,12 @@ redirects:
5454
destination: / # Don't do this
5555
```
5656

57-
Instead, reach out to Fern to enable automatic homepage redirects, an internal setting that handles broken links without needing manual redirects.
57+
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:
58+
59+
```yaml title="docs.yml"
60+
settings:
61+
hide-404-page: true
62+
```
5863

5964
</Accordion>
6065
<Accordion title="Versioning and redirects">

0 commit comments

Comments
 (0)