Update from support feedback: fork PR preview limitation#6443
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from support feedback: fork PR preview limitation#6443mintlify[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
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
Adds a "Fork pull requests" subsection to
deploy/preview-deploymentsexplaining that the Mintlify GitHub App cannot generate previews for PRs opened from forks, why (the app only accesses repositories where it's installed), and the maintainer workaround of pushing the contributor's branch to a branch in the main repository. Cross-links this fromdeploy/githuband notes the tracked feature request for native fork-PR previews.Support context
Note
Low Risk
Documentation-only updates with no product, API, or deployment behavior changes.
Overview
Documents that automatic preview deployments do not run for pull requests opened from forks, because the Mintlify GitHub App only has access to repositories where it is installed (not the contributor’s fork).
Adds a Fork pull requests subsection under preview deployments (English plus
es,fr,zh) with the maintainer workaround—push the contributor’s branch into the upstream repo (or use an integration branch)—and a note pointing to the tracked GitHub discussion for native fork-PR previews on public repos.Cross-links from Manage repository access on the GitHub deploy page in each locale to that subsection.
Reviewed by Cursor Bugbot for commit 04fc56c. Bugbot is set up for automated code reviews on this repo. Configure here.