Skip to content

Manage documentation deployments #6291

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dks333 wants to merge 1 commit into from
Closed

Manage documentation deployments #6291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 26 additions & 5 deletions deploy/deployments.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
boost: 3
---

import Counter from '/snippets/counter.mdx';

Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected.

If your latest changes are not appearing on your live site, first check that the GitHub account or organization that owns your docs repository has the GitHub App installed. See [GitHub troubleshooting](/deploy/github#troubleshooting) for more information.
Expand All @@ -13,16 +15,35 @@

## Manually trigger a deployment

<Frame>
![Clean Shot 2026 06 05 At 11 43 41@2x](/images/CleanShot-2026-06-05-at-11.43.41@2x.png)
</Frame>

<Frame>
![Translations Dashboard Dark](/images/translations/translations-dashboard-dark.png)
</Frame>

<Counter />

@cursor cursor Bot Jun 26, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Demo counter in deployment docs

Medium Severity

The deployments page imports and renders the interactive Counter snippet from snippets/counter.mdx, which is a React demo (+/− widget) used elsewhere for component examples. Readers following deployment instructions see an unrelated control with no connection to triggering or managing deployments.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 77f3f34. Configure here.


<Steps>
<Step title="Verify your latest commit was successful.">
Check that your latest commit appears in your docs repository and did not encounter any errors.
</Step>
<Step title="Manually trigger a deployment.">
Go to your [dashboard](https://app.mintlify.com) and click the deploy button.
<Frame>
<img src="/images/deployments/manual-update-light.png" alt="The manual update button emphasized with an orange rectangle." className="block dark:hidden" />
<img src="/images/deployments/manual-update-dark.png" alt="The manual update button emphasized with an orange rectangle." className="hidden dark:block" />
</Frame>

<Frame>
<img
alt="The manual update button emphasized with an orange rectangle."
className="block dark:hidden"
src="/images/deployments/manual-update-light.png"
/>
<img
alt="The manual update button emphasized with an orange rectangle."
className="hidden dark:block"
src="/images/deployments/manual-update-dark.png"
/>
</Frame>
</Step>
</Steps>

Expand All @@ -35,7 +56,7 @@
Go to the [Danger zone](https://app.mintlify.com/settings/organization/danger-zone) in the settings page of your dashboard.
</Step>
<Step title="Delete the deployment.">
1. In the **Delete my deployment** section, provide a reason for deletion.

Check warning on line 59 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L59 

Avoid first-person pronouns such as 'my'.
2. Click the delete button and confirm that you want to delete the deployment.
</Step>
</Steps>
Expand All @@ -44,4 +65,4 @@
Deleting a deployment is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period.
</Warning>

If you have multiple deployments, Mintlify redirects you to another deployment after deletion. If you delete your only deployment, Mintlify redirects you to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion.
If you have multiple deployments, Mintlify redirects you to another deployment after deletion. If you delete your only deployment, Mintlify redirects you to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion.
Binary file added images/CleanShot-2026-06-05-at-11.43.41@2x.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading