Skip to content

feat(search): rebalance in-product search ranking and enforce trailing-slash URLs - #95

Merged
WomB0ComB0 merged 2 commits into
mainfrom
feat/search-ranking-seo
Jul 24, 2026
Merged

feat(search): rebalance in-product search ranking and enforce trailing-slash URLs#95
WomB0ComB0 merged 2 commits into
mainfrom
feat/search-ranking-seo

Conversation

@WomB0ComB0

@WomB0ComB0 WomB0ComB0 commented Jul 24, 2026

Copy link
Copy Markdown
Member

Why

The generated SDK reference tree is 769 files against 41 handwritten pages. Typedoc/doxygen output currently outweighs the guides in in-product search, so a query like "quickstart" competes with functions/inferCookieDomain.

What changed

All of it lives in docs.json. No content files touched, so the SDK sync automation has nothing to overwrite.

Change Effect
boost: 4 on "Start here" (all 5 locales) Landing, concepts, quickstart, authentication, errors rank first
boost: 2 on SDK "Overview"/"Languages" and API "Overview" Handwritten SDK and API guides outrank generated members
boost: 0.3 on "Generated Package References" De-prioritised, still searchable
seo.trailingSlash: true Consistent canonical / og:url / sitemap URLs across en/es/ar/hi/zh
download-spec in contextual.options Surfaces specs/coordination.json + specs/infrastructure.json; self-scopes to API reference pages

Why de-boost rather than searchable: false

searchable: false also removes a page from AI assistant context, not just the search bar. Assistant answers about SDK symbols would get worse. boost: 0.3 fixes ranking while keeping the reference available to the assistant, and it is one line instead of 769 frontmatter stamps.

Boost inherits down the tree and page frontmatter still wins, so any page can override later.

Validation

Changed subtrees validated against the published https://mintlify.com/docs.json schema:

  • seo — keys within {indexing, metatags, organization, trailingSlash}, additionalProperties: false satisfied, trailingSlash is boolean
  • contextual.options — all 7 values in enum, download-spec included
  • 9 boosted groups — every key within the allowed group property set, all boosts numeric

The mint CLI could not run locally (its puppeteer install fails in this environment), so schema checks were done directly against the sub-schemas.

Not included, needs the dashboard

  • Related pages requires the add-on toggle; related frontmatter is inert until it is on
  • Maximum search results is a dashboard setting, not docs.json
  • Search filters require an Enterprise plan and products or versions in navigation. This site has neither, so enabling them would have no visible effect

Test plan

  • Preview deploy: search "quickstart" and "authentication", confirm handwritten pages rank above generated SDK members
  • Confirm generated SDK pages still return for symbol queries (e.g. initAnalytics)
  • Check canonical and og:url emit trailing slashes on an en and a non-en page
  • Confirm Download API spec appears on API reference pages and not on guides

Summary by CodeRabbit

  • Documentation
    • Improved documentation navigation ordering across English, Spanish, Arabic, Hindi, and Chinese sections.
    • Clarified the SDK overview entry for easier discovery.
    • Standardized documentation URLs with trailing slashes for improved consistency.
    • Added an option to download API specifications from relevant documentation contexts.

…g-slash URLs

The generated SDK reference tree is 769 files against 41 handwritten pages,
so typedoc/doxygen output dominates in-product search and buries the guides.
Fix the ranking at the navigation-group level rather than stamping frontmatter
across the generated tree, which the sync automation would overwrite.

- boost 4 on the "Start here" group in all five locales
- boost 2 on the handwritten SDK and API reference landing groups
- boost 0.3 on "Generated Package References" to de-prioritise without
  removing it (searchable: false would also strip it from AI assistant
  context, which we want to keep)
- seo.trailingSlash: true for consistent canonical, og:url and sitemap URLs
  across the five locales
- add download-spec to the contextual menu; it self-scopes to API reference
  pages and exposes specs/coordination.json and specs/infrastructure.json
@gemini-code-assist

Copy link
Copy Markdown

Caution

The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased.

@github-actions github-actions Bot added area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc. labels Jul 24, 2026
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 5ce7979d-c8f9-47ff-867c-a6f52e36ab21

📥 Commits

Reviewing files that changed from the base of the PR and between c5c07a6 and ff416f8.

📒 Files selected for processing (1)
  • docs.json

📝 Walkthrough

Walkthrough

Updated docs.json navigation priorities, added the SDK overview page, enabled trailing-slash SEO URLs, and added the download-spec contextual option.

Changes

Documentation configuration

Layer / File(s) Summary
Navigation priorities and SDK overview
docs.json
Added navigation boost values across English and localized sections, and added sdks/index to the SDK overview pages.
SEO and contextual settings
docs.json
Enabled trailing slashes in SEO URLs and added download-spec to contextual options.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes to search ranking and trailing-slash URL handling.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/search-ranking-seo

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@WomB0ComB0
WomB0ComB0 merged commit ec45f2f into main Jul 24, 2026
12 checks passed
@WomB0ComB0
WomB0ComB0 deleted the feat/search-ranking-seo branch July 24, 2026 08:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:content MDX/MD documentation content area:meta Repo meta — docs.json, README, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants