Skip to content

docs: document per-deployment search max results setting#5844

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/6582d3ed
Open

docs: document per-deployment search max results setting#5844
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/6582d3ed

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 16, 2026

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

  • Added a "Set the maximum number of search results" section to optimize/search-boost.mdx describing the setting, when to use it, valid range, default, and how it interacts with the Search API pageSize parameter.
  • Mirrored the new section in the Spanish, French, and Chinese translations.

Context

Source PR introduces a per-deployment searchSettings.maxResults configured via Settings > Search in the dashboard. The Search API pageSize parameter 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 pageSize parameter.

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 1100, default 6), 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 of search-boost.mdx.

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

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 16, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 16, 2026, 8:49 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 16, 2026

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

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview May 16, 2026, 8:48 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@skeptrunedev
Copy link
Copy Markdown
Contributor

bugbot review

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

✅ 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.

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