Skip to content
Merged
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
2 changes: 1 addition & 1 deletion changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ noindex: true

## Section-level search boost

Search indexing now supports section-level boosts and page-level boosts, letting you promote specific content so it ranks higher for relevant queries. See the [search boost](/optimize/search-boost) documentation for more details.
Search indexing now supports section-level boosts and page-level boosts, letting you promote specific content so it ranks higher for relevant queries. See the [Search](/optimize/search#boost-search-ranking) documentation for more details.

## Improvements

Expand Down
2 changes: 1 addition & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@
"ai/llmstxt",
"ai/skillmd",
"ai/model-context-protocol",
"optimize/search-boost",
"optimize/search",
"optimize/seo",
"ai/markdown-export",
"optimize/pdf-exports",
Expand Down
Binary file added images/search-settings-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/search-settings-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 0 additions & 60 deletions optimize/search-boost.mdx

This file was deleted.

83 changes: 83 additions & 0 deletions optimize/search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: "Search"
description: "Configure the in-product search bar on your Mintlify documentation site, including ranking boosts and the number of results returned per query."
keywords: ["search", "search ranking", "search boost", "boost", "search prioritization", "maximum search results", "max results"]
---

Configure how the search bar on your Mintlify-hosted documentation site behaves. These settings only affect in-product search. They do not change how external search engines index your pages.

## Boost search ranking

Use `boost` to bias the in-product search ranking of specific pages or sections. The value is a numeric multiplier applied to each chunk's relevance score: `boost: 3` makes a chunk three times as relevant as it would be without a boost.

### Boost a single page

Set `boost` in a page's [frontmatter](/organize/pages) to multiply its search ranking.

```mdx
---
title: "Custom domain"
description: "Connect your custom domain to your Mintlify documentation."
boost: 3
---
```

### Boost a navigation group

Set `boost` on a group in your `docs.json` navigation to apply the multiplier to every page under it.

```json
{
"navigation": {
"groups": [
{
"group": "Get started",
"boost": 5,
"pages": [
"quickstart",
"concepts"
]
}
]
}
}
```

A page inherits the boost factor from its nearest ancestor that sets one. A child page or nested group can override the inherited boost by setting its own `boost` value. A page's frontmatter `boost` always wins over a value inherited from the navigation.

### De-prioritize content

Use a value below `1` to push pages further down in search results. For example, `boost: 0.5` halves a page's relevance score relative to other pages. A `boost` of `1` is equivalent to no boost.

```mdx
---
title: "Deprecated API"
description: "Documentation for the deprecated v1 API."
boost: 0.25
---
```

<Note>
Boost factors compose with the existing relevance score. Use them sparingly. Large multipliers can cause less-relevant pages to dominate search results and degrade overall search quality.
</Note>

## Maximum search results

Control how many results the search bar returns per query from your dashboard. The default is `6` results. You can set any value between `1` and `100`.

In your dashboard, navigate to **Settings** > **Deployment** > **Search**, set **Maximum search results** to the value you want, and select **Save changes**.

<Frame>
<img
alt="The Search settings page in the dashboard with the Maximum search results stepper set to 6."
className="block dark:hidden"
src="/images/search-settings-light.png"
/>
<img
alt="The Search settings page in the dashboard with the Maximum search results stepper set to 6."
className="hidden dark:block"
src="/images/search-settings-dark.png"
/>
</Frame>

Higher values surface more matches per query, which is useful for sites with broad topic coverage where users expect to scan many candidates. Lower values keep the results panel compact and push users toward the top-ranked match.
2 changes: 1 addition & 1 deletion organize/pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Use frontmatter to control:
</ResponseField>

<ResponseField name="boost" type="number">
Multiply the page's in-product search ranking by this factor. Use values greater than `1` to prioritize the page and values between `0` and `1` to de-prioritize it. See [Search boost](/optimize/search-boost) for details.
Multiply the page's in-product search ranking by this factor. Use values greater than `1` to prioritize the page and values between `0` and `1` to de-prioritize it. See [Search](/optimize/search#boost-search-ranking) for details.
</ResponseField>

<ResponseField name="deprecated" type="boolean">
Expand Down
2 changes: 1 addition & 1 deletion organize/settings-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ Groups for organizing content into labeled sections.

##### `navigation.groups[].boost`

Numeric multiplier applied to the in-product search ranking of every page in this group. Pages inherit the boost factor from the nearest ancestor group that sets one. Use values greater than `1` to prioritize, between `0` and `1` to de-prioritize. See [Search boost](/optimize/search-boost).
Numeric multiplier applied to the in-product search ranking of every page in this group. Pages inherit the boost factor from the nearest ancestor group that sets one. Use values greater than `1` to prioritize, between `0` and `1` to de-prioritize. See [Search](/optimize/search#boost-search-ranking).

**Type:** number

Expand Down
4 changes: 4 additions & 0 deletions redirects.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
[
{
"source": "/optimize/search-boost",
"destination": "/optimize/search"
},
{
"source": "/ai/assistant",
"destination": "/assistant/index"
Expand Down
Loading