feat(search): rebalance in-product search ranking and enforce trailing-slash URLs - #95
Merged
Conversation
…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
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughUpdated ChangesDocumentation configuration
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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.
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.boost: 4on "Start here" (all 5 locales)boost: 2on SDK "Overview"/"Languages" and API "Overview"boost: 0.3on "Generated Package References"seo.trailingSlash: trueog:url/ sitemap URLs acrossen/es/ar/hi/zhdownload-specincontextual.optionsspecs/coordination.json+specs/infrastructure.json; self-scopes to API reference pagesWhy de-boost rather than
searchable: falsesearchable: falsealso removes a page from AI assistant context, not just the search bar. Assistant answers about SDK symbols would get worse.boost: 0.3fixes 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.jsonschema:seo— keys within{indexing, metatags, organization, trailingSlash},additionalProperties: falsesatisfied,trailingSlashis booleancontextual.options— all 7 values in enum,download-specincludedThe
mintCLI 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
relatedfrontmatter is inert until it is ondocs.jsonproductsorversionsin navigation. This site has neither, so enabling them would have no visible effectTest plan
initAnalytics)og:urlemit trailing slashes on anenand a non-enpageSummary by CodeRabbit