Skip to content

Boost search ranking for single-word title pages#5670

Merged
skeptrunedev merged 2 commits intomainfrom
boost-single-word-h1-pages
May 5, 2026
Merged

Boost search ranking for single-word title pages#5670
skeptrunedev merged 2 commits intomainfrom
boost-single-word-h1-pages

Conversation

@skeptrunedev
Copy link
Copy Markdown
Contributor

@skeptrunedev skeptrunedev commented May 5, 2026

Summary

  • Applied boost: 3 to English pages whose frontmatter title is a single word (e.g. Assistant, Quickstart, Cards, Playground).
  • Short titles tend to mark canonical landing pages for a topic, so users searching that exact term should land on them first in the in-product search bar.
  • Scoped to top-level English files only (74 pages). Localized pages under es/, fr/, and zh/ are not modified — Chinese in particular doesn't use whitespace between words, so the "single word" heuristic doesn't translate cleanly. Happy to follow up with localized versions if wanted.

Files touched

74 .mdx files. Notable examples:

  • assistant/index.mdx ("Assistant")
  • quickstart.mdx ("Quickstart")
  • index.mdx ("Introduction")
  • components/*.mdx (Cards, Tabs, Steps, Icons, etc.)
  • integrations/analytics/*.mdx (PostHog, Mixpanel, Segment, etc.)
  • deploy/*.mdx (GitHub, GitLab, Vercel, Cloudflare)

Each change is a single line — boost: 3 appended to the existing frontmatter block.

Test plan

  • Verify in-product search ranks single-word pages higher for exact-match queries (e.g. searching "assistant" returns assistant/index.mdx first).
  • Confirm no frontmatter parsing regressions (build succeeds).
  • Sanity-check that no page already had a boost value being clobbered (script skipped any with existing boost:).

Note

Low Risk
Low risk documentation metadata change that only adjusts page ranking via frontmatter boost, with no code or runtime logic changes.

Overview
Improves in-product search ranking for canonical landing pages by adding boost: 3 to the frontmatter of ~74 top-level English .mdx pages whose title is a single word (for example Assistant, Quickstart, Cards, Playground).

No content changes beyond the added frontmatter field; localized pages under es/, fr/, and zh/ are not modified.

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

Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first.
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 5, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 5, 2026, 3:38 PM

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.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 4caccf3. Configure here.

Comment thread api-playground/websocket-playground.mdx Outdated
…round ranking

`api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
@skeptrunedev skeptrunedev merged commit 9200586 into main May 5, 2026
5 checks passed
@skeptrunedev skeptrunedev deleted the boost-single-word-h1-pages branch May 5, 2026 17:31
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