docs: document per-deployment search max results setting#5844
Open
mintlify[bot] wants to merge 2 commits into
Open
docs: document per-deployment search max results setting#5844mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
bugbot review |
There was a problem hiding this comment.
✅ Bugbot reviewed your changes and found no new issues!
Comment @cursor review or bugbot run to trigger another review on this PR
Reviewed by Cursor Bugbot for commit 4800365. Configure here.
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 dashboard setting that lets each deployment override the default number of results returned by the in-product search bar (1–100, defaults to six).
Changes
optimize/search-boost.mdxdescribing the setting, when to use it, valid range, default, and how it interacts with the Search APIpageSizeparameter.Context
Source PR introduces a per-deployment
searchSettings.maxResultsconfigured via Settings > Search in the dashboard. The Search APIpageSizeparameter still takes precedence when provided.Note
Low Risk
Low risk documentation-only change that adds guidance for a new dashboard setting and clarifies its interaction with the Search API
pageSizeparameter.Overview
Documents a new dashboard "Max results" setting that caps the number of results returned by the Mintlify-hosted in-product search bar (valid range
1–100, default6), including guidance on when to increase/decrease it.Clarifies that this limit only affects the embedded search bar and that the Search API still honors per-request
pageSize(overriding the dashboard value), and mirrors the new section in the Spanish, French, and Chinese versions ofsearch-boost.mdx.Reviewed by Cursor Bugbot for commit 4800365. Bugbot is set up for automated code reviews on this repo. Configure here.