docs: document searchable option for hidden navigation elements#5835
Open
mintlify[bot] wants to merge 2 commits into
Open
docs: document searchable option for hidden navigation elements#5835mintlify[bot] wants to merge 2 commits into
searchable option for hidden navigation elements#5835mintlify[bot] wants to merge 2 commits into
Conversation
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.
Summary
Documents the new
searchableproperty onhiddentabs, groups, anchors, and dropdowns. When set alongsidehidden: true, descendant pages stay in site search, the sitemap,llms.txt, AI assistant context, and search engine indexing while remaining hidden from the sidebar.Changes
searchable" section toorganize/hidden-pages.mdxwith a configuration example and a list of behaviors enabled by the flag.searchableResponseFieldnext to the existinghiddenfield for tabs, anchors, and dropdowns inorganize/settings-structure.mdx.es,fr, andzhtranslations.Context
Backs the discovery-surface changes in mintlify/server#5291, which route the search index, sitemap,
llms.txt, AI assistant content, and SEO metadata through a searchable-aware hidden lookup so opt-in pages no longer receivenoindexwhile still being excluded from the rendered navigation.Note
Low Risk
Low risk documentation-only change that clarifies behavior of
hiddennavigation items and introduces no runtime/code-path modifications.Overview
Adds documentation for a new
searchable: trueflag that can be combined withhidden: trueon navigation elements (tabs/groups/anchors/dropdowns) to keep descendant pages included in site search, sitemap,llms.txt, AI assistant context, and SEO indexing while still hiding them from the sidebar.Updates the
docs.jsonschema docs (settings-structure.mdx) to include thesearchablefield next tohiddenfor tabs, anchors, and dropdowns, and mirrors these docs updates acrosses,fr, andzhlocales.Reviewed by Cursor Bugbot for commit ee9e0b8. Bugbot is set up for automated code reviews on this repo. Configure here.