Skip to content

Document the search boost feature#5562

Merged
skeptrunedev merged 3 commits intomainfrom
sk/docs-search-boost
Apr 28, 2026
Merged

Document the search boost feature#5562
skeptrunedev merged 3 commits intomainfrom
sk/docs-search-boost

Conversation

@skeptrunedev
Copy link
Copy Markdown
Contributor

@skeptrunedev skeptrunedev commented Apr 28, 2026

Summary

  • New optimize/search-boost.mdx page covering: how boost works as a numeric multiplier on in-product search ranking, frontmatter usage on a single page, group-level usage in docs.json navigation (with inheritance and override rules), and de-prioritization via sub-1 values
  • Add a boost <ResponseField> to organize/pages.mdx next to noindex, with a link to the new page
  • Register optimize/search-boost in the Optimize navigation group of docs.json

The boost feature shipped in mintlify/server#4740 and mintlify/mint#7238. This PR is the user-facing documentation.

Test plan

  • mint broken-links clean
  • mint dev renders the new page and the updated frontmatter ResponseField correctly
  • vale optimize/search-boost.mdx organize/pages.mdx clean

Note

Low Risk
Low risk documentation-only change; the only behavioral impact is docs-site navigation ordering/search weighting examples in docs.json.

Overview
Adds new documentation for Search boost (optimize/search-boost.mdx), explaining boost as a multiplier for in-product search ranking, including page-frontmatter and docs.json group usage with inheritance/override rules.

Updates existing references to surface the new option: introduces a boost frontmatter field in organize/pages.mdx, documents navigation.groups[].boost in organize/settings-reference.mdx, and registers optimize/search-boost in the Optimize navigation; also adds sample boost values to the Get started group and Changelog tab in docs.json.

Reviewed by Cursor Bugbot for commit 383a1a4. Bugbot is set up for automated code reviews on this repo. Configure here.

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.
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 28, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 28, 2026, 12:53 AM

Add a navigation.groups[].boost subsection under navigation.groups in
the docs.json schema reference page, with a link out to the topic page.
Bias in-product search ranking toward onboarding content and away from
the changelog. Doubles as a live test of the search boost feature.
Copy link
Copy Markdown
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

Comment thread optimize/search-boost.mdx
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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
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. For example, `boost: 3` makes a chunk three times as relevant as it would be without a boost.

Comment thread optimize/search-boost.mdx
Comment on lines +58 to +60
<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>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<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>
<Tip>
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.
</Tip>

@skeptrunedev skeptrunedev merged commit 8909948 into main Apr 28, 2026
6 checks passed
@skeptrunedev skeptrunedev deleted the sk/docs-search-boost branch April 28, 2026 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants