From 2f21abb921ea132733d1857b689cec37fb608ff0 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 24 Aug 2026 10:44:03 -0700 Subject: [PATCH 1/5] docs(deploy): document instant rollbacks Add deploy/rollbacks.mdx covering how to roll back to a previous build, how to return to the latest build, generated files that stay frozen during a rollback, and the current limitations. Link it from the deployments page and note the new audit log actions. Screenshots are placeholders pending review. Co-Authored-By: Claude Opus 5 (1M context) --- dashboard/audit-logs.mdx | 2 +- deploy/deployments.mdx | 4 +++ deploy/rollbacks.mdx | 63 ++++++++++++++++++++++++++++++++++++++++ docs.json | 1 + 4 files changed, 69 insertions(+), 1 deletion(-) create mode 100644 deploy/rollbacks.mdx diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx index 0529e504f9..e3aec97399 100644 --- a/dashboard/audit-logs.mdx +++ b/dashboard/audit-logs.mdx @@ -44,7 +44,7 @@ Filter audit logs to find specific activities. |------------------|--------------------------------------------------------------------| | Organization | Organization settings updates and deletion requests. | | Member | Team member invitations, removals, role changes, and credential revocations. | -| Deployment | Deployment configuration changes including custom domains, authentication, Git sources, and MCP client credentials. | +| Deployment | Deployment configuration changes including custom domains, authentication, Git sources, and MCP client credentials, plus rollbacks and build promotions. | | Preview deployment | Preview deployment creation, updates, and authentication changes. | | API key | API key and discovery API key creation and deletion. | | Assistant | Assistant setting updates like deflection email, web search sites, and starter questions. | diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index 2859ff253a..df3290b074 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -26,6 +26,10 @@ If you have the GitHub App installed, but changes are still not deploying, manua +## Roll back a deployment + +If a change reaches your live site that you need to remove immediately, you can serve a previous successful build instead of reverting commits and waiting for a new build. See [Rollbacks](/deploy/rollbacks). + ## Delete a deployment You can permanently delete a deployment from the [Danger zone](https://app.mintlify.com/settings/organization/danger-zone) in your dashboard settings. This action is irreversible and removes all deployment data, including any associated preview deployments. diff --git a/deploy/rollbacks.mdx b/deploy/rollbacks.mdx new file mode 100644 index 0000000000..6c64922557 --- /dev/null +++ b/deploy/rollbacks.mdx @@ -0,0 +1,63 @@ +--- +title: "Rollbacks" +description: "Restore your live documentation site to a previous successful build from your dashboard without reverting commits or waiting for a rebuild." +keywords: ["instant rollback", "revert deployment", "restore build", "promote build", "broken deployment"] +--- + + + Rollbacks are available on [Enterprise plans](https://mintlify.com/pricing?ref=rollbacks). + + +Roll back your live site to any of your last 10 successful builds. A rollback changes which build your site serves. It does not revert commits in your repository and it does not trigger a new build, so your site changes in seconds. + +Use a rollback when a change reaches your live site that you need to remove immediately, and fix the underlying content in your repository afterward. + +Only organization admins can roll back a deployment. + +## Roll back to a previous build + + + + In your [dashboard](https://app.mintlify.com), select your site, then click **Activity**. + + + On the **Live** tab, click a successful build to expand it. The commit message and author help you identify which build you want. + + + Click **Roll back**. Your site serves that build within seconds. + + {/* TODO: screenshots pending review */} + + An expanded build in the activity history with the Roll back button emphasized by an orange rectangle. + An expanded build in the activity history with the Roll back button emphasized by an orange rectangle. + + + + +In your activity history, the build your site is serving shows a **Rolled back** label. + +## Return to the latest build + +Your site continues to build while it serves a previous build. New commits build and appear in your activity history, but they do not go live until you return to the latest build. + +To return to the latest build, use either of these buttons in your activity history: + +- **Undo rollback** on the build you rolled back to. +- **Promote** on the most recent successful build. + +Both serve the most recent successful build, including any commits that landed in the meantime. If that build needs to be rebuilt first, Mintlify queues the rebuild and your site updates when it finishes. + +## Generated files and search filters + +A rollback restores the pages your site serves, and search results follow immediately. Generated files and search filters, including `llms.txt`, `llms-full.txt`, and `skill.md`, stay in the state they were in before the rollback. They update when you return to the latest build. + +## Limitations + +- You can roll back to any of your last 10 successful builds. The build your site is currently serving is always available, even after 10 more builds complete. +- Deployments with [authentication](/deploy/authentication-setup) enabled do not support rollbacks. +- You cannot roll back a preview deployment. +- You cannot roll back to a build that completed before rollbacks became available. + +## Review rollback history + +Your [audit logs](/dashboard/audit-logs) record rollbacks and promotions under the Deployment category, including who performed each action and when. diff --git a/docs.json b/docs.json index e9f454e79a..8e33d64d40 100644 --- a/docs.json +++ b/docs.json @@ -189,6 +189,7 @@ "group": "Deployments", "root": "deploy/deployments", "pages": [ + "deploy/rollbacks", "deploy/preview-deployments", "deploy/github", "deploy/ghes", From ee514d5c406acc3a2010f59b76f83568498f2592 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 24 Aug 2026 11:13:57 -0700 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=92=85?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- dashboard/audit-logs.mdx | 2 +- deploy/deployments.mdx | 2 +- docs.json | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx index e3aec97399..1f6da6b07a 100644 --- a/dashboard/audit-logs.mdx +++ b/dashboard/audit-logs.mdx @@ -44,7 +44,7 @@ Filter audit logs to find specific activities. |------------------|--------------------------------------------------------------------| | Organization | Organization settings updates and deletion requests. | | Member | Team member invitations, removals, role changes, and credential revocations. | -| Deployment | Deployment configuration changes including custom domains, authentication, Git sources, and MCP client credentials, plus rollbacks and build promotions. | +| Deployment | Deployment configuration changes including custom domains, authentication, Git sources, MCP client credentials, rollbacks, and build promotions. | | Preview deployment | Preview deployment creation, updates, and authentication changes. | | API key | API key and discovery API key creation and deletion. | | Assistant | Assistant setting updates like deflection email, web search sites, and starter questions. | diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index df3290b074..1627dbc1d2 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -28,7 +28,7 @@ If you have the GitHub App installed, but changes are still not deploying, manua ## Roll back a deployment -If a change reaches your live site that you need to remove immediately, you can serve a previous successful build instead of reverting commits and waiting for a new build. See [Rollbacks](/deploy/rollbacks). +If a change reaches your live site that you must remove immediately, serve a previous successful build instead of reverting commits and waiting for a new build. See [Rollbacks](/deploy/rollbacks). ## Delete a deployment diff --git a/docs.json b/docs.json index 8e33d64d40..185ab43675 100644 --- a/docs.json +++ b/docs.json @@ -189,12 +189,12 @@ "group": "Deployments", "root": "deploy/deployments", "pages": [ - "deploy/rollbacks", - "deploy/preview-deployments", "deploy/github", "deploy/ghes", "deploy/gitlab", - "deploy/bitbucket" + "deploy/bitbucket", + "deploy/preview-deployments", + "deploy/rollbacks" ] }, { From f9166efc6e5b9a18c2cfad18226701235ffdfddb Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 24 Aug 2026 11:46:28 -0700 Subject: [PATCH 3/5] copy edit --- deploy/rollbacks.mdx | 38 ++++++++++++++------------------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/deploy/rollbacks.mdx b/deploy/rollbacks.mdx index 6c64922557..1919cf1190 100644 --- a/deploy/rollbacks.mdx +++ b/deploy/rollbacks.mdx @@ -1,7 +1,7 @@ --- title: "Rollbacks" -description: "Restore your live documentation site to a previous successful build from your dashboard without reverting commits or waiting for a rebuild." -keywords: ["instant rollback", "revert deployment", "restore build", "promote build", "broken deployment"] +description: "Restore your live Mintlify site to a previous successful build from your dashboard without reverting commits or waiting for a rebuild." +keywords: ["instant", "revert deployment", "restore build", "promote build", "broken deployment"] --- @@ -10,54 +10,44 @@ keywords: ["instant rollback", "revert deployment", "restore build", "promote bu Roll back your live site to any of your last 10 successful builds. A rollback changes which build your site serves. It does not revert commits in your repository and it does not trigger a new build, so your site changes in seconds. -Use a rollback when a change reaches your live site that you need to remove immediately, and fix the underlying content in your repository afterward. +Use a rollback when a change reaches your live site that you must remove immediately. Only organization admins can roll back a deployment. ## Roll back to a previous build - - In your [dashboard](https://app.mintlify.com), select your site, then click **Activity**. + + Navigate to the [activity](https://app.mintlify.com/activity) page in your dashboard. - On the **Live** tab, click a successful build to expand it. The commit message and author help you identify which build you want. + On the **Live** tab, click a successful build to expand it. + + Use the commit message and author help you identify which build you want. Click **Roll back**. Your site serves that build within seconds. - - {/* TODO: screenshots pending review */} - - An expanded build in the activity history with the Roll back button emphasized by an orange rectangle. - An expanded build in the activity history with the Roll back button emphasized by an orange rectangle. - -In your activity history, the build your site is serving shows a **Rolled back** label. - ## Return to the latest build Your site continues to build while it serves a previous build. New commits build and appear in your activity history, but they do not go live until you return to the latest build. -To return to the latest build, use either of these buttons in your activity history: - -- **Undo rollback** on the build you rolled back to. -- **Promote** on the most recent successful build. - -Both serve the most recent successful build, including any commits that landed in the meantime. If that build needs to be rebuilt first, Mintlify queues the rebuild and your site updates when it finishes. +There are two ways to return to the latest build: -## Generated files and search filters +- Click **Undo rollback** on the build you rolled back to. +- Click **Promote** on the most recent successful build. -A rollback restores the pages your site serves, and search results follow immediately. Generated files and search filters, including `llms.txt`, `llms-full.txt`, and `skill.md`, stay in the state they were in before the rollback. They update when you return to the latest build. +Both serve the most recent successful build, including any commits that landed in the meantime. ## Limitations -- You can roll back to any of your last 10 successful builds. The build your site is currently serving is always available, even after 10 more builds complete. +- You can roll back to any of your last 10 successful builds. - Deployments with [authentication](/deploy/authentication-setup) enabled do not support rollbacks. - You cannot roll back a preview deployment. - You cannot roll back to a build that completed before rollbacks became available. ## Review rollback history -Your [audit logs](/dashboard/audit-logs) record rollbacks and promotions under the Deployment category, including who performed each action and when. +Your [audit logs](/dashboard/audit-logs) record rollbacks and promotions under the **Deployment** category, including who performed each action and when. From 67e7c16af883bec70802fd0e8cc3adc82f7ea322 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 24 Aug 2026 14:36:46 -0700 Subject: [PATCH 4/5] typo --- deploy/rollbacks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/rollbacks.mdx b/deploy/rollbacks.mdx index 1919cf1190..ef1a76c0f8 100644 --- a/deploy/rollbacks.mdx +++ b/deploy/rollbacks.mdx @@ -23,7 +23,7 @@ Only organization admins can roll back a deployment. On the **Live** tab, click a successful build to expand it. - Use the commit message and author help you identify which build you want. + Use the commit message and author to help you identify the build that you want to roll back to. Click **Roll back**. Your site serves that build within seconds. From b3c0ef19824f19f41bb85b82dad6029c53b106a2 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Mon, 24 Aug 2026 14:37:04 -0700 Subject: [PATCH 5/5] better grammar --- deploy/rollbacks.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/rollbacks.mdx b/deploy/rollbacks.mdx index ef1a76c0f8..73c322c787 100644 --- a/deploy/rollbacks.mdx +++ b/deploy/rollbacks.mdx @@ -26,7 +26,7 @@ Only organization admins can roll back a deployment. Use the commit message and author to help you identify the build that you want to roll back to. - Click **Roll back**. Your site serves that build within seconds. + Click **Roll back**. Your site serves the selected build within seconds.