From b2dd02b4e0b5fdec5b961ff28a3cf3b2203b51c3 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 24 Aug 2026 23:05:25 +0000 Subject: [PATCH 1/4] docs: clarify how to reach the Previews tab from the dashboard --- deploy/preview-deployments.mdx | 31 ++++++++++++++++++------------- 1 file changed, 18 insertions(+), 13 deletions(-) diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 95a81cff89..52087c71b8 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -40,10 +40,11 @@ A maintainer with write access to the main repository can preview changes from a You can manually create a preview for any branch. 1. Go to your [dashboard](https://app.mintlify.com/). -2. Click **Previews**. -3. Click **Create custom preview**. -4. Enter the name of the branch you want to preview. -5. Click **Create preview**. +2. Open the organization dropdown in the upper-left corner and click **Settings**. +3. On the activity dashboard, click the **Previews** tab. +4. Click **Create custom preview**. +5. Enter the name of the branch you want to preview. +6. Click **Create preview**. ### API @@ -53,8 +54,11 @@ You can also create preview deployments programmatically using the [Trigger prev Redeploy a preview to refresh content or retry after a failed deployment. -1. Click the preview from your [dashboard](https://app.mintlify.com/). -2. Click **Redeploy**. +1. Go to your [dashboard](https://app.mintlify.com/). +2. Open the organization dropdown in the upper-left corner and click **Settings**. +3. On the activity dashboard, click the **Previews** tab. +4. Click the preview you want to redeploy. +5. Click **Redeploy**. The Previews menu with the deploy button emphasized by an orange rectangle. @@ -97,15 +101,16 @@ Restrict preview access to authenticated members of your Mintlify organization. Password-protect a specific preview to share it with external reviewers without adding them to your Mintlify organization. This option is available when creating a manual preview and is not shown when organization authentication is already enabled for your deployment. 1. Go to your [dashboard](https://app.mintlify.com/). -2. Click **Previews**. -3. Click **Create custom preview**. -4. Enter the name of the branch you want to preview. -5. Toggle **Make private** on and enter a password. Passwords must be at least 8 characters. +2. Open the organization dropdown in the upper-left corner and click **Settings**. +3. On the activity dashboard, click the **Previews** tab. +4. Click **Create custom preview**. +5. Enter the name of the branch you want to preview. +6. Toggle **Make private** on and enter a password. Passwords must be at least 8 characters. The Create a custom preview modal with the Make private toggle enabled and a password field. The Create a custom preview modal with the Make private toggle enabled and a password field. -6. Click **Create preview**. +7. Click **Create preview**. ## Preview lifetime @@ -113,7 +118,7 @@ Preview deployments stay live as long as their source branch exists in your repo - **Automatic previews**: The preview for a pull request remains available while the PR is open and after it's merged or closed, as long as the source branch still exists. When you delete the branch, the next dashboard sync removes the preview. - **Manual previews**: Manual previews stay live until you delete them. Redeploying a manual preview refreshes its content against the latest commit on the specified branch. -- **Delete a preview**: In your [dashboard](https://app.mintlify.com/), go to **Previews**, open the preview, and click **Delete** to remove it immediately. +- **Delete a preview**: In your [dashboard](https://app.mintlify.com/), open the organization dropdown in the upper-left corner, click **Settings**, and then click the **Previews** tab on the activity dashboard. Open the preview and click **Delete** to remove it immediately. Preview URLs are unique per branch. If you delete a preview and later recreate one for the same branch, Mintlify may issue a new URL. @@ -123,7 +128,7 @@ Mintlify generates preview URLs automatically. The subdomain and domain are not If your preview deployment fails, try these troubleshooting steps. -- **View the build logs**: In your [dashboard](https://app.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures. +- **View the build logs**: In your [dashboard](https://app.mintlify.com/), open the organization dropdown in the upper-left corner, click **Settings**, and then click the **Previews** tab on the activity dashboard. Click the failed preview to see the deployment logs. - **Check your configuration**: - Missing `docs.json` at the configured content root. If your `docs.json` is in a subdirectory, confirm the **docs.json is in a subdirectory** setting points to the correct path. - Invalid `docs.json` syntax (for example, an empty file or a stray trailing comma that breaks JSON parsing). From 3e2b086ced8df1e34b2fbc6a02b98628874fef67 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 24 Aug 2026 23:09:19 +0000 Subject: [PATCH 2/4] docs: collapse Settings + activity dashboard into one step --- deploy/preview-deployments.mdx | 37 ++++++++++++++++------------------ 1 file changed, 17 insertions(+), 20 deletions(-) diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 52087c71b8..c4f483cc8d 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -39,12 +39,11 @@ A maintainer with write access to the main repository can preview changes from a You can manually create a preview for any branch. -1. Go to your [dashboard](https://app.mintlify.com/). -2. Open the organization dropdown in the upper-left corner and click **Settings**. -3. On the activity dashboard, click the **Previews** tab. -4. Click **Create custom preview**. -5. Enter the name of the branch you want to preview. -6. Click **Create preview**. +1. In your dashboard, open the organization dropdown in the upper-left corner and click **Settings** to go to the activity dashboard. +2. Click the **Previews** tab. +3. Click **Create custom preview**. +4. Enter the name of the branch you want to preview. +5. Click **Create preview**. ### API @@ -54,11 +53,10 @@ You can also create preview deployments programmatically using the [Trigger prev Redeploy a preview to refresh content or retry after a failed deployment. -1. Go to your [dashboard](https://app.mintlify.com/). -2. Open the organization dropdown in the upper-left corner and click **Settings**. -3. On the activity dashboard, click the **Previews** tab. -4. Click the preview you want to redeploy. -5. Click **Redeploy**. +1. In your dashboard, open the organization dropdown in the upper-left corner and click **Settings** to go to the activity dashboard. +2. Click the **Previews** tab. +3. Click the preview you want to redeploy. +4. Click **Redeploy**. The Previews menu with the deploy button emphasized by an orange rectangle. @@ -100,17 +98,16 @@ Restrict preview access to authenticated members of your Mintlify organization. Password-protect a specific preview to share it with external reviewers without adding them to your Mintlify organization. This option is available when creating a manual preview and is not shown when organization authentication is already enabled for your deployment. -1. Go to your [dashboard](https://app.mintlify.com/). -2. Open the organization dropdown in the upper-left corner and click **Settings**. -3. On the activity dashboard, click the **Previews** tab. -4. Click **Create custom preview**. -5. Enter the name of the branch you want to preview. -6. Toggle **Make private** on and enter a password. Passwords must be at least 8 characters. +1. In your dashboard, open the organization dropdown in the upper-left corner and click **Settings** to go to the activity dashboard. +2. Click the **Previews** tab. +3. Click **Create custom preview**. +4. Enter the name of the branch you want to preview. +5. Toggle **Make private** on and enter a password. Passwords must be at least 8 characters. The Create a custom preview modal with the Make private toggle enabled and a password field. The Create a custom preview modal with the Make private toggle enabled and a password field. -7. Click **Create preview**. +6. Click **Create preview**. ## Preview lifetime @@ -118,7 +115,7 @@ Preview deployments stay live as long as their source branch exists in your repo - **Automatic previews**: The preview for a pull request remains available while the PR is open and after it's merged or closed, as long as the source branch still exists. When you delete the branch, the next dashboard sync removes the preview. - **Manual previews**: Manual previews stay live until you delete them. Redeploying a manual preview refreshes its content against the latest commit on the specified branch. -- **Delete a preview**: In your [dashboard](https://app.mintlify.com/), open the organization dropdown in the upper-left corner, click **Settings**, and then click the **Previews** tab on the activity dashboard. Open the preview and click **Delete** to remove it immediately. +- **Delete a preview**: In your dashboard, open the organization dropdown in the upper-left corner, click **Settings** to go to the activity dashboard, and then click the **Previews** tab. Open the preview and click **Delete** to remove it immediately. Preview URLs are unique per branch. If you delete a preview and later recreate one for the same branch, Mintlify may issue a new URL. @@ -128,7 +125,7 @@ Mintlify generates preview URLs automatically. The subdomain and domain are not If your preview deployment fails, try these troubleshooting steps. -- **View the build logs**: In your [dashboard](https://app.mintlify.com/), open the organization dropdown in the upper-left corner, click **Settings**, and then click the **Previews** tab on the activity dashboard. Click the failed preview to see the deployment logs. +- **View the build logs**: In your dashboard, open the organization dropdown in the upper-left corner, click **Settings** to go to the activity dashboard, and then click the **Previews** tab. Click the failed preview to see the deployment logs. - **Check your configuration**: - Missing `docs.json` at the configured content root. If your `docs.json` is in a subdirectory, confirm the **docs.json is in a subdirectory** setting points to the correct path. - Invalid `docs.json` syntax (for example, an empty file or a stray trailing comma that breaks JSON parsing). From 05d30db067529b7787edb5a6c0d8f14f06f4eb29 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 16:02:09 +0000 Subject: [PATCH 3/4] docs: clarify preview restriction requires Enterprise add-on --- deploy/preview-deployments.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index c4f483cc8d..90a3962133 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -83,6 +83,10 @@ The widget only appears on preview deployments, not on your live site or local p By default, preview deployments are publicly accessible to anyone with the URL. You can restrict access by requiring organization authentication for all previews or by password-protecting individual previews. + + Restricting access to preview deployments requires the Preview authentication add-on, which is only available on the Enterprise plan. It is not included in the Pro plan's password protection feature (which gates your production site, not previews) or in the SSO Login add-on (which controls sign-in to the Mintlify dashboard). Contact your account team to add it to your subscription. + + ### Require organization authentication Restrict preview access to authenticated members of your Mintlify organization. From 6f52fca7e4710c702712368e062123cfdaceff46 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 25 Aug 2026 16:04:52 +0000 Subject: [PATCH 4/4] docs: tighten preview access restriction callout --- deploy/preview-deployments.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 90a3962133..d539136101 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -84,7 +84,7 @@ The widget only appears on preview deployments, not on your live site or local p By default, preview deployments are publicly accessible to anyone with the URL. You can restrict access by requiring organization authentication for all previews or by password-protecting individual previews. - Restricting access to preview deployments requires the Preview authentication add-on, which is only available on the Enterprise plan. It is not included in the Pro plan's password protection feature (which gates your production site, not previews) or in the SSO Login add-on (which controls sign-in to the Mintlify dashboard). Contact your account team to add it to your subscription. + Restricting preview access is an Enterprise add-on. It is separate from Pro password protection (which gates production, not previews) and the SSO Login add-on (which gates the dashboard). Contact your account team to enable it. ### Require organization authentication