mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
8909948779
* Document the search boost feature Add an optimize/search-boost page explaining how to bias in-product search ranking by setting a numeric boost multiplier in page frontmatter or on a docs.json navigation group, including inheritance rules and de-prioritization with sub-1 values. Cross-reference from the boost frontmatter ResponseField in organize/pages and add the new page to the Optimize navigation group. * Document boost in the docs.json schema reference Add a navigation.groups[].boost subsection under navigation.groups in the docs.json schema reference page, with a link out to the topic page. * Apply boost: 2 to Get started and boost: 0.5 to Changelog Bias in-product search ranking toward onboarding content and away from the changelog. Doubles as a live test of the search boost feature.
61 lines
2.0 KiB
Plaintext
61 lines
2.0 KiB
Plaintext
---
|
|
title: "Search boost"
|
|
description: "Bias your documentation site's in-product search ranking toward specific pages or sections by setting a boost multiplier in frontmatter or your `docs.json` navigation."
|
|
keywords: ["search ranking", "search boost", "boost", "search prioritization"]
|
|
---
|
|
|
|
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` only affects the search bar on your Mintlify-hosted documentation site. It does not change how external search engines index your pages.
|
|
|
|
## 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>
|