Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@
"ai/contextual-menu",
"optimize/analytics",
"optimize/feedback",
"optimize/related-pages",
"ai/llmstxt",
"ai/skillmd",
"ai/model-context-protocol",
Expand Down
84 changes: 84 additions & 0 deletions optimize/related-pages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: "Related pages"
description: "Show related page links at the bottom of each documentation page to help users discover relevant content."
keywords: ["related pages", "related topics", "content discovery", "navigation", "recommendations"]
---

Related pages display a list of links at the bottom of each documentation page, helping users discover relevant content they might not find through navigation alone.

<Info>
To use related pages, enable them from the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard.
</Info>

## Modes

Related pages support two modes: **automatic** and **manual**.

### Automatic

Automatic mode uses search to find and display pages related to the current page's content. This mode requires no additional configuration beyond enabling the feature.

When automatic mode is active, Mintlify analyzes the page title and matches it against your documentation to surface the most relevant pages. Results are scoped to the same language and version as the current page.

Check warning on line 21 in optimize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/related-pages.mdx#L21

In general, use active voice instead of passive voice ('are scoped').

### Manual

Manual mode only shows related pages that you explicitly define in frontmatter. Use this mode when you want full control over which pages appear as related content.

In manual mode, pages without a `relatedPages` frontmatter property do not display any related pages.

## Configure related pages

Enable and configure related pages from the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard. You can:

- Toggle related pages on or off
- Choose between automatic and manual mode
- Set the maximum number of related pages to display (up to 10, default is 5)

## Frontmatter overrides

Use the `relatedPages` frontmatter property to override the dashboard configuration on individual pages. This works in both automatic and manual modes.

### Define related pages

Specify a list of internal paths or external URLs to display as related pages:

```yaml
---
title: "Authentication"
relatedPages:
- /security/api-keys
- /security/oauth
- https://example.com/external-guide
---
```

Internal paths resolve their titles and icons automatically from your navigation configuration. External URLs display the URL as the title.

### Set explicit titles

Provide a custom title for any related page by using the `Title: path` format:

```yaml
---
title: "Authentication"
relatedPages:
- Getting started with API keys: /security/api-keys
- OAuth setup guide: /security/oauth
- External reference: https://example.com/external-guide
---
```

### Disable related pages on a specific page

Set `relatedPages` to `false` to hide related pages on a specific page, even when the feature is enabled globally:

Check warning on line 73 in optimize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/related-pages.mdx#L73

In general, use active voice instead of passive voice ('is enabled').

```yaml
---
title: "Changelog"
relatedPages: false
---
```

<Note>
Frontmatter-defined related pages are limited to a maximum of 10 entries.

Check warning on line 83 in optimize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/related-pages.mdx#L83

In general, use active voice instead of passive voice ('are limited').
</Note>
4 changes: 4 additions & 0 deletions organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ Use frontmatter to control:
Set to `true` to hide the HTTP method badge (such as GET or POST) next to the page title in the sidebar. Use this for API pages where you want a cleaner sidebar appearance.
</ResponseField>

<ResponseField name="relatedPages" type="string[] | false">
A list of related page paths or URLs to display at the bottom of the page, or `false` to disable related pages on this page. See [Related pages](/optimize/related-pages) for details.
</ResponseField>

<ResponseField name="groups" type="string[]">
Restrict the page to users in specific groups. Users must belong to at least one listed group to access the page. You must configure [authentication](/deploy/authentication-setup) first. See [Control access with groups](/deploy/authentication-setup#control-access-with-groups) for more information.
</ResponseField>
Expand Down
Loading