Improve docs from user feedback: clarify fork support for preview API - #7078
Open
mintlify[bot] wants to merge 2 commits into
Open
Improve docs from user feedback: clarify fork support for preview API#7078mintlify[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
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 preview deployments cannot be built from fork branches, on the Trigger preview deployment API page and in a new help center article.
Changes
/api/preview/triggerstating the branch must exist in the connected repository, fork branches are not supported, and linking to the fork workaround./help-center/preview-deployment-not-created-for-fork-branchcovering the missing-preview symptom for fork PRs and API calls, linking to the canonical Fork pull requests section.docs.json.Feedback basis
Other feedback in the window was positive with no corrective signal, so no other pages were changed.
Note
Low Risk
Documentation-only changes with no product or API behavior impact.
Overview
Documents that preview deployments cannot use fork branches, addressing feedback that the Trigger preview deployment API page did not state this clearly.
Adds a Branch requirements section on
api/preview/trigger(andes,fr,zhlocales) explaining thatbranchmust exist on the connected repo, fork branches are unsupported because the GitHub App is only on the main repo, with a link to the fork PR workaround.Introduces help center article
preview-deployment-not-created-for-fork-branchin English and localized copies, covering missing preview links on fork PRs, failed API calls with fork branches, and the maintainer push-to-upstream workflow. Registers the page in Help center navigation viadocs.json,es.json,fr.json, andzh.json.Reviewed by Cursor Bugbot for commit 08512c1. Bugbot is set up for automated code reviews on this repo. Configure here.