diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index d54ac2ac42..244237f1bd 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -29,6 +29,16 @@ When you create a pull request, the Mintlify bot automatically adds a link to vi Link to view deployment in the pull request timeline + + Automatic previews are not created for pull requests opened from forked repositories. Because the Mintlify GitHub App is not installed on the fork, the bot cannot access the pull request to trigger a preview build. This affects external contributors and contributors working from personal forks. + + To preview changes from a fork, use one of these workarounds: + + - **Push to a branch on the origin repository**: Open the pull request from a branch on the same repository your docs are connected to instead of a fork. + - **Create a manual preview**: A maintainer with dashboard access can [create a manual preview](#manual-previews) for the contributor's branch after pulling it into the origin repository. + - **Trigger a preview from CI**: Call the [Trigger preview deployment](/api/preview/trigger) API from a trusted CI job that has access to your Mintlify API key. Do not expose the key to workflows that run untrusted code from forks. + + ### Manual previews You can manually create a preview for any branch.