Update from support feedback: fork PR preview limitation#6425
Open
mintlify-development[bot] wants to merge 1 commit into
Open
Update from support feedback: fork PR preview limitation#6425mintlify-development[bot] wants to merge 1 commit into
mintlify-development[bot] wants to merge 1 commit into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
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
1 participant
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
Document that automatic preview deployments are not created for pull requests opened from forked repositories, and list the supported workarounds.
Changes
Context
Support has had to hand-type this explanation for customers whose external contributors open PRs from forks and see no preview link. Documenting it inline lets readers self-serve.
Note
Low Risk
Documentation-only change with no product or runtime impact.
Overview
Adds a Warning under Automatic previews on the Preview deployments page so readers know fork-based PRs do not get automatic preview links (Mintlify app is not on the fork).
The callout lists three workarounds: open the PR from a branch on the origin repo, have a maintainer create a manual preview, or trigger a preview via the Trigger preview deployment API from trusted CI—with a note not to expose API keys to workflows running untrusted fork code.
Reviewed by Cursor Bugbot for commit 689ad15. Bugbot is set up for automated code reviews on this repo. Configure here.