From 56bdd612e7e14ce7734afc7dfbd6b7273aaa88c0 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 26 Aug 2026 18:35:01 +0000 Subject: [PATCH] docs: apply style and tone fixes to preview deployment pages --- api/preview/trigger.mdx | 1 - deploy/preview-deployments.mdx | 4 ++-- es/deploy/preview-deployments.mdx | 2 +- .../preview-deployment-not-created-for-fork-branch.mdx | 2 +- fr/deploy/preview-deployments.mdx | 2 +- .../preview-deployment-not-created-for-fork-branch.mdx | 2 +- .../preview-deployment-not-created-for-fork-branch.mdx | 2 +- zh/deploy/preview-deployments.mdx | 2 +- 8 files changed, 8 insertions(+), 9 deletions(-) diff --git a/api/preview/trigger.mdx b/api/preview/trigger.mdx index 649c4415f7..a4150dd287 100644 --- a/api/preview/trigger.mdx +++ b/api/preview/trigger.mdx @@ -2,7 +2,6 @@ title: "Trigger preview deployment" openapi: "/openapi.json POST /project/preview/{projectId}" keywords: ["preview", "preview deployment", "branch preview", "staging"] - --- Use this endpoint to programmatically create or update a preview deployment for a Git branch. If a preview already exists for the specified branch, the endpoint triggers a redeployment instead of creating a duplicate. diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 95a81cff89..a93dfd278b 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -8,7 +8,7 @@ keywords: ["preview URLs", "pull request previews", "branch previews", "staging Preview deployments require a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=preview-deployments). -Preview deployments let you see how changes to your docs look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes. +Preview deployments let you see how changes to your docs look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes. Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes. @@ -111,7 +111,7 @@ Password-protect a specific preview to share it with external reviewers without Preview deployments stay live as long as their source branch exists in your repository and continue to receive updates on every push. -- **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. +- **Automatic previews**: The preview for a pull request remains available while the pull request 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. diff --git a/es/deploy/preview-deployments.mdx b/es/deploy/preview-deployments.mdx index 9bd57e3a6e..26476e7c91 100644 --- a/es/deploy/preview-deployments.mdx +++ b/es/deploy/preview-deployments.mdx @@ -134,7 +134,7 @@ Protege con contraseña una vista previa específica para compartirla con reviso Las implementaciones de vista previa se mantienen activas mientras la rama de origen exista en tu repositorio y siguen recibiendo actualizaciones con cada push. -- **Vistas previas automáticas**: La vista previa de una pull request permanece disponible mientras la PR esté abierta y después de que se fusione o cierre, siempre que la rama de origen siga existiendo. Eliminar la rama elimina la vista previa en la siguiente sincronización del dashboard. +- **Vistas previas automáticas**: La vista previa de una pull request permanece disponible mientras la pull request esté abierta y después de que se fusione o cierre, siempre que la rama de origen siga existiendo. Eliminar la rama elimina la vista previa en la siguiente sincronización del dashboard. - **Vistas previas manuales**: Las vistas previas manuales permanecen activas hasta que las eliminas. Volver a desplegar una vista previa manual actualiza su contenido con el último commit de la rama especificada. - **Eliminar una vista previa**: En tu [dashboard](https://app.mintlify.com/), ve a **Previews**, abre la vista previa y haz clic en **Delete** para eliminarla de inmediato. diff --git a/es/help-center/preview-deployment-not-created-for-fork-branch.mdx b/es/help-center/preview-deployment-not-created-for-fork-branch.mdx index 2260eefd12..166e86618a 100644 --- a/es/help-center/preview-deployment-not-created-for-fork-branch.mdx +++ b/es/help-center/preview-deployment-not-created-for-fork-branch.mdx @@ -4,7 +4,7 @@ description: "Por qué las solicitudes de extracción de forks y las ramas de fo keywords: ["fork pull request", "no preview link", "preview deployment missing", "fork branch preview", "trigger preview API fork", "external contributor preview"] --- -Si una solicitud de extracción abierta desde un fork no muestra ningún enlace de implementación de vista previa, o si una llamada al endpoint [Trigger preview deployment](/es/api/preview/trigger) con una rama de un fork falla, este es el comportamiento esperado. Mintlify no genera implementaciones de vista previa a partir de ramas de forks. +Si una solicitud de extracción abierta desde un fork no muestra ningún enlace de implementación de vista previa, este es el comportamiento esperado. Lo mismo ocurre si falla una llamada al endpoint [Trigger preview deployment](/es/api/preview/trigger) con una rama de un fork. Mintlify no genera implementaciones de vista previa a partir de ramas de forks. La aplicación de GitHub de Mintlify debe estar instalada en un repositorio para generar una vista previa. La aplicación está instalada en tu repositorio principal, no en los forks de los colaboradores, por lo que no puede leer un fork ni generar una vista previa a partir de él. Esto se aplica tanto a las vistas previas automáticas de solicitudes de extracción como a las vistas previas activadas a través de la API. El valor de `branch` en una solicitud de API debe existir en el repositorio conectado a tu proyecto de Mintlify. diff --git a/fr/deploy/preview-deployments.mdx b/fr/deploy/preview-deployments.mdx index 2ed88b14db..7c6824b206 100644 --- a/fr/deploy/preview-deployments.mdx +++ b/fr/deploy/preview-deployments.mdx @@ -136,7 +136,7 @@ Protégez par mot de passe un aperçu spécifique pour le partager avec des rév Les déploiements de prévisualisation restent disponibles tant que leur branche source existe dans votre référentiel et continuent de recevoir des mises à jour à chaque push. -- **Aperçus automatiques** : L'aperçu d'une pull request reste disponible tant que la PR est ouverte, ainsi qu'après sa fusion ou sa fermeture, à condition que la branche source existe encore. La suppression de la branche retire l'aperçu lors de la prochaine synchronisation du Dashboard. +- **Aperçus automatiques** : L'aperçu d'une pull request reste disponible tant que la pull request est ouverte, ainsi qu'après sa fusion ou sa fermeture, à condition que la branche source existe encore. La suppression de la branche retire l'aperçu lors de la prochaine synchronisation du Dashboard. - **Aperçus manuels** : Les aperçus manuels restent disponibles jusqu'à ce que vous les supprimiez. Redéployer un aperçu manuel actualise son contenu par rapport au dernier commit de la branche spécifiée. - **Supprimer un aperçu** : Dans votre [Dashboard](https://app.mintlify.com/), accédez à **Previews**, ouvrez l'aperçu et cliquez sur **Delete** pour le supprimer immédiatement. diff --git a/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx b/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx index 518502082f..ab050e3914 100644 --- a/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx +++ b/fr/help-center/preview-deployment-not-created-for-fork-branch.mdx @@ -4,7 +4,7 @@ description: "Pourquoi les pull requests de forks et les branches de forks trans keywords: ["fork pull request", "no preview link", "preview deployment missing", "fork branch preview", "trigger preview API fork", "external contributor preview"] --- -Si une pull request ouverte depuis un fork n'affiche aucun lien de déploiement de prévisualisation, ou si un appel à l'endpoint [Trigger preview deployment](/fr/api/preview/trigger) avec une branche de fork échoue, il s'agit du comportement attendu. Mintlify ne génère pas de déploiements de prévisualisation à partir de branches de forks. +Si une pull request ouverte depuis un fork n'affiche aucun lien de déploiement de prévisualisation, il s'agit du comportement attendu. Il en va de même si un appel à l'endpoint [Trigger preview deployment](/fr/api/preview/trigger) avec une branche de fork échoue. Mintlify ne génère pas de déploiements de prévisualisation à partir de branches de forks. L'application GitHub Mintlify doit être installée sur un dépôt pour générer une prévisualisation. L'application est installée sur votre dépôt principal, pas sur les forks des contributeurs, elle ne peut donc pas lire un fork ni générer une prévisualisation à partir de celui-ci. Cela s'applique à la fois aux prévisualisations automatiques de pull requests et aux prévisualisations déclenchées via l'API. La valeur de `branch` dans une requête d'API doit exister dans le dépôt connecté à votre projet Mintlify. diff --git a/help-center/preview-deployment-not-created-for-fork-branch.mdx b/help-center/preview-deployment-not-created-for-fork-branch.mdx index 675ad3ed64..3c53fed7e7 100644 --- a/help-center/preview-deployment-not-created-for-fork-branch.mdx +++ b/help-center/preview-deployment-not-created-for-fork-branch.mdx @@ -4,7 +4,7 @@ description: "Why fork pull requests and fork branches passed to the preview API keywords: ["fork pull request", "no preview link", "preview deployment missing", "fork branch preview", "trigger preview API fork", "external contributor preview"] --- -If a pull request opened from a fork shows no preview deployment link, or a call to the [Trigger preview deployment](/api/preview/trigger) endpoint with a fork branch fails, this is expected behavior. Mintlify does not build preview deployments from fork branches. +If a pull request opened from a fork shows no preview deployment link, this is expected behavior. The same is true if a call to the [Trigger preview deployment](/api/preview/trigger) endpoint with a fork branch fails. Mintlify does not build preview deployments from fork branches. The Mintlify GitHub App must be installed on a repository to build a preview. The app is installed on your main repository, not on contributor forks, so it cannot read a fork or build a preview against it. This applies to both automatic pull request previews and previews triggered through the API. The `branch` value in an API request must exist in the repository connected to your Mintlify project. diff --git a/zh/deploy/preview-deployments.mdx b/zh/deploy/preview-deployments.mdx index afdcb69d91..ffdad0de15 100644 --- a/zh/deploy/preview-deployments.mdx +++ b/zh/deploy/preview-deployments.mdx @@ -136,7 +136,7 @@ keywords: ["preview URLs", "pull request previews", "branch previews", "staging 只要预览部署对应的源 branch 仍存在于你的仓库中，预览就会持续在线，并在每次推送时接收更新。 -- **自动预览**：拉取请求的预览在 PR 处于打开状态期间，以及合并或关闭后 (只要源 branch 仍存在) 都会保持可用。删除该 branch 后，预览会在下一次控制台同步时被移除。 +- **自动预览**：拉取请求的预览在拉取请求处于打开状态期间，以及合并或关闭后 (只要源 branch 仍存在) 都会保持可用。删除该 branch 后，预览会在下一次控制台同步时被移除。 - **手动预览**：手动预览会一直在线，直到你删除它为止。重新部署手动预览会根据指定 branch 上的最新提交刷新其内容。 - **删除预览**：在你的[控制台](https://app.mintlify.com/)中，前往 **Previews**，打开该预览，然后点击 **Delete** 立即将其移除。