Document section-level search boost#5563
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
boostfield for navigation groups and page frontmatter, which biases search ranking for specific sections of a docs site.The triggering PR added
boost(a numeric multiplier) to navigation groups indocs.jsonand to page frontmatter. Pages inherit the closest ancestor group's boost factor; entries with a resolved factor of 1 are treated as no boost. Server-side indexers use the resolved boost as a per-chunk weight at index time.Changes
organize/navigation.mdx— New "Search ranking boost" subsection under Groups explaining the multiplier semantics, inheritance, and override behavior, with adocs.jsonexample that boosts a "Get started" group and deprioritizes a "Legacy" group, plus a frontmatter snippet showing per-page override.organize/pages.mdx— NewboostResponseField in the page metadata list, linking back to the navigation reference for full details.Validation
mint broken-links: no broken links.mint validate: pre-existing errors only (unrelated language config and redirects issues already present onmain).Note
Low Risk
Documentation-only changes that describe the new
boostmetadata; no runtime behavior or security-sensitive logic is modified.Overview
Adds documentation for a new search ranking multiplier called
boost.Updates
organize/navigation.mdxwith a Search ranking boost section describing group-levelboost, inheritance/override behavior, and adocs.jsonexample, and updatesorganize/pages.mdxto document the page frontmatterboostfield with a link back to the navigation section.Reviewed by Cursor Bugbot for commit 0efde9c. Bugbot is set up for automated code reviews on this repo. Configure here.