Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-6582d3ed.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

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 to multiply its search ranking.
---
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.
{
  "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.
---
title: "Deprecated API"
description: "Documentation for the deprecated v1 API."
boost: 0.25
---
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.

Set the maximum number of search results

Control how many results your in-product search bar returns by setting Max results in your dashboard under Settings > Search. The value must be an integer between 1 and 100. Mintlify returns up to six results by default. Increase this value when your documentation covers many adjacent topics and users benefit from seeing more matches at once. Lower it to keep the results list focused and reduce visual noise. This setting only affects the search bar on your Mintlify-hosted documentation site. The Search API continues to honor the pageSize parameter on each request, which overrides the dashboard setting when provided.