Update from support feedback: Related topics preview limitation - #6835
Closed
mintlify[bot] wants to merge 2 commits into
Closed
Update from support feedback: Related topics preview limitation#6835mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
2 participants
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
Clarify that the Related topics add-on only renders on production deployments, since users expect to verify configuration on branch previews.
Changes
organize/related-pages.mdxexplaining that both automatic and manualrelatedsuggestions are skipped on branch previews because no search index is built for previews.deploy/preview-deployments.mdxcross-linking to Related topics.Support context
Note
Low Risk
Documentation-only updates across English and localized MDX; no product or runtime behavior changes.
Overview
Documents that the Related topics add-on is production-only, addressing confusion when users try to validate
relatedconfiguration on branch preview URLs.Adds a Warning callout at the top of
organize/related-pages.mdx(and es, fr, zh equivalents) stating that automatic and manualrelatedfrontmatter are skipped on previews—no search index is built there—and linking to preview deployments docs.Adds a Features that behave differently in previews section to
deploy/preview-deployments.mdx(localized variants) with a cross-link to Related topics and the same guidance to verify after merge.Reviewed by Cursor Bugbot for commit e66322b. Bugbot is set up for automated code reviews on this repo. Configure here.