Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
04d3762
Remove 119 unreferenced images
ethanpalm Sep 22, 2026
e72f30f
Remove CloudFront and Route 53 screenshots
ethanpalm Sep 22, 2026
751d9e7
Remove GitHub repository selection screenshot
ethanpalm Sep 23, 2026
08c561f
Remove GitLab project ID screenshot
ethanpalm Sep 23, 2026
d015008
Remove GitLab access token screenshot
ethanpalm Sep 23, 2026
ae474fe
Remove GitLab webhooks page screenshot
ethanpalm Sep 23, 2026
92def8b
Remove Show webhook token screenshot
ethanpalm Sep 23, 2026
b3eb109
Remove GitLab webhook settings screenshot
ethanpalm Sep 23, 2026
f662eb6
Remove GitLab webhook test screenshot
ethanpalm Sep 23, 2026
08fc107
Remove multi-repo Git settings screenshot
ethanpalm Sep 23, 2026
5030697
Remove redeploy preview screenshot
ethanpalm Sep 23, 2026
9c8ce23
Remove preview authentication toggle screenshot
ethanpalm Sep 23, 2026
e14e1ae
Remove private preview modal screenshot
ethanpalm Sep 23, 2026
784352e
Remove Export to CSV screenshot
ethanpalm Sep 23, 2026
22d0c46
Remove feedback add-ons toggles screenshot
ethanpalm Sep 23, 2026
c883568
Remove search results setting screenshot
ethanpalm Sep 23, 2026
9a1501c
Replace range selector screenshot with text
ethanpalm Sep 23, 2026
ad6f51b
Remove assistant status toggle screenshot
ethanpalm Sep 23, 2026
f34dbe2
Remove assistant search domains screenshot
ethanpalm Sep 23, 2026
e27f605
Remove highlight text screenshot
ethanpalm Sep 23, 2026
2eced47
Remove file attachment screenshot
ethanpalm Sep 23, 2026
b2a6861
Remove contextual menu graphic
ethanpalm Sep 23, 2026
dffdc6e
Remove Speakeasy copy URL screenshot
ethanpalm Sep 23, 2026
0c8c74f
Remove Swagger Editor convert screenshot
ethanpalm Sep 23, 2026
63b6e06
Remove automations dashboard screenshot
ethanpalm Sep 23, 2026
09af269
Remove mint test interface screenshot
ethanpalm Sep 23, 2026
c7cc6e3
Remove dashboard support button screenshot
ethanpalm Sep 23, 2026
e9e25e7
Remove Google Workspace add SAML app screenshot
ethanpalm Sep 23, 2026
b5c9369
Remove Google Workspace IdP details screenshot
ethanpalm Sep 23, 2026
aa22d0b
Remove Google Workspace service provider screenshot
ethanpalm Sep 23, 2026
f95c5e2
Remove GA4 Data Streams screenshot
ethanpalm Sep 23, 2026
fc523d7
Remove Osano managed rule screenshot
ethanpalm Sep 23, 2026
c010c28
Remove Astro guide repository settings screenshot
ethanpalm Sep 23, 2026
f4fe1cd
copy edits
ethanpalm Sep 24, 2026
108e089
Remove cut screenshots from Spanish pages
ethanpalm Sep 24, 2026
dfff8e4
Remove cut screenshots from French pages
ethanpalm Sep 24, 2026
4143b00
Remove cut screenshots from Chinese pages
ethanpalm Sep 24, 2026
1c284f8
Delete image files for removed screenshots
ethanpalm Sep 24, 2026
77e7bb1
update contact support for new UI
ethanpalm Sep 24, 2026
cd6ab0a
Fix dangling colon after removing Swagger screenshot
ethanpalm Sep 24, 2026
085ae70
Sync Spanish translations with English
ethanpalm Sep 24, 2026
ac31328
Sync French translations with English
ethanpalm Sep 24, 2026
106c067
Sync Chinese translations with English
ethanpalm Sep 24, 2026
a9c3d52
Delete images only stale translations used
ethanpalm Sep 24, 2026
01d8c88
Add English anchor ids to Spanish Git concepts accordions
ethanpalm Sep 24, 2026
1022360
Add English anchor ids to French Git concepts accordions
ethanpalm Sep 24, 2026
5c3c295
Add English anchor ids to Chinese Git concepts accordions
ethanpalm Sep 24, 2026
f115450
remove links to mint automation
ethanpalm Sep 24, 2026
306b177
Merge origin/main into tidy-up-image-files
ethanpalm Sep 24, 2026
440f0bb
Remove mint automations links from Spanish pages
ethanpalm Sep 24, 2026
836b0ef
Remove mint automations links from French pages
ethanpalm Sep 24, 2026
ba0cc05
Remove mint automations links from Chinese pages
ethanpalm Sep 24, 2026
9888a5a
Fix stale sign-up link text in Spanish custom frontend guide
ethanpalm Sep 24, 2026
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
7 changes: 0 additions & 7 deletions ai/contextual-menu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,6 @@ The contextual menu includes several pre-built options that you can enable by ad
| **Download API spec** | `download-spec` | Downloads your deployment's OpenAPI spec. If there are multiple specs, downloads them as a zip archive. Only appears on API reference pages. |
| **Custom options** | Object | Add custom options to the contextual menu |

<Frame>
<img
src="/images/contextual-menu/contextual-menu.png"
alt="The expanded contextual menu showing the Copy page, View as Markdown, Open in ChatGPT, and Open in Claude menu items."
/>
</Frame>

## Enable the contextual menu

Add the `contextual` field to your `docs.json` file and specify which options you want to include. Options appear in the menu in the order you list them.
Expand Down
14 changes: 0 additions & 14 deletions analytics/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,6 @@ Export analytics categories to CSV for deeper analysis, reporting, or archival.
2. Select a category to export: traffic, referrals, assistant conversations, searches, or feedback.
3. Wait for Mintlify to email you a download link.

<Frame>
<img
src="/images/analytics/export-to-csv-light.png"
alt="The Export to CSV button on the analytics page."
className="block dark:hidden"
/>

<img
src="/images/analytics/export-to-csv-dark.png"
alt="The Export to CSV button on the analytics page."
className="hidden dark:block"
/>
</Frame>

## Interpret traffic exports

Traffic exports break down page views by visitor category so you can compare traffic from humans, agents, search crawlers, and other bots.
Expand Down
16 changes: 1 addition & 15 deletions analytics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,21 +43,7 @@ Analytics data typically appears within a few minutes of an interaction. Very re

## Filter by time period

Use the range selector in an analytics view to adjust the time period for the displayed data. Exports also use the selected time range.

<Frame>
<img
src="/images/analytics/range-selector-light.png"
alt="The range selector expanded to show options for viewing different time periods of data."
className="block dark:hidden"
/>

<img
src="/images/analytics/range-selector-dark.png"
alt="The range selector expanded to show options for viewing different time periods of data."
className="hidden dark:block"
/>
</Frame>
Use the range selector in an analytics view to adjust the time period for the displayed data. Choose a preset, like **Last 7 days** or **All time**, or select a custom range on the calendar. Exports also use the selected time range.

## Filter by page or path

Expand Down
4 changes: 0 additions & 4 deletions api-playground/adding-sdk-examples.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,6 @@ Go to your [Speakeasy Dashboard](https://app.speakeasy.com) and open the **API R
</Note>

From the registry entry's page, copy the provided public URL.

<Frame>
![Screenshot showing the combined spec registry entry with the copy URL function emphasized with a red square.](/images/speakeasy/copy-combined-spec-url.png)
</Frame>
</Step>
<Step title="Add the combined spec URL to your `docs.json` file">

Expand Down
6 changes: 1 addition & 5 deletions api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,7 @@ If your API pages aren't displaying correctly, check these common configuration
validation here, the problem likely lies elsewhere.

Additionally, Mintlify does not support OpenAPI 2.0. If your document uses this version of the specification,
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/) (under Edit \> Convert to OpenAPI 3):

<Frame>
![Screenshot of the Swagger Editor with the Edit menu expanded and the "Convert to OpenAPI 3" menu item highlighted.](/images/convert-oas-3.png)
</Frame>
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/) (under Edit \> Convert to OpenAPI 3).
</Accordion>
<Accordion title="One of my OpenAPI pages is completely blank">
A misspelled `openapi` field in the page metadata usually causes this issue. Make sure
Expand Down
4 changes: 0 additions & 4 deletions api/automations/trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,6 @@ This endpoint only supports automations configured with a **Custom schedule** tr
- **Release events**: Run the **Draft changelog** automation when you cut a release tag, so the changelog drafts at the same time the release ships.
- **Custom tooling**: Trigger automations from internal tools, Slack commands, or scheduled jobs you already run.

## Find the automation ID

Run [`mint automations list`](/cli/commands#mint-automations-list) in your terminal and copy the ID from the output.

## Example

Trigger an automation from a GitHub Action whenever code merges to `main`:
Expand Down
12 changes: 1 addition & 11 deletions assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ Configure the assistant on the [Assistant](https://app.mintlify.com/products/ass

## Enable or disable the assistant

Toggle the status to enable or disable the assistant for your documentation site.

<Frame>
<img src="/images/assistant/status-light.png" alt="The assistant status toggle in the dashboard." className="block dark:hidden" />
<img src="/images/assistant/status-dark.png" alt="The assistant status toggle in the dashboard." className="hidden dark:block" />
</Frame>
On the [Assistant](https://app.mintlify.com/products/assistant) page in your dashboard, click the status toggle to enable or disable the assistant for your site.

## Set deflection emails

Expand Down Expand Up @@ -51,11 +46,6 @@ In the Response Handling section, configure domains that the assistant can use f
- Domains must be publicly available.
- The assistant can't search domains that require JavaScript to load.

<Frame>
<img src="/images/assistant/search-domains-light.png" alt="The assistant search domains panel enabled in the dashboard. The assistant is configured to search the mintlify.com/pricing domain." className="block dark:hidden" />
<img src="/images/assistant/search-domains-dark.png" alt="The assistant search domains panel enabled in the dashboard. The assistant is configured to search the mintlify.com/pricing domain." className="hidden dark:block" />
</Frame>

For more precise control over what the assistant can search, use filtering syntax.

- **Domain-level filtering**
Expand Down
10 changes: 0 additions & 10 deletions assistant/use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,6 @@ https://yourdocs.mintlify.site/quickstart?assistant=How%20do%20I%20get%20started

Highlight text on a page and click the **Add to assistant** button to open the assistant chat panel and add the highlighted text as context. You can add multiple text snippets or code blocks to the assistant's context.

<Frame>
<img src="/images/assistant/highlight-light.png" alt="The Add to assistant button above highlighted text in light mode." className="block dark:hidden" />
<img src="/images/assistant/highlight-dark.png" alt="The Add to assistant button above highlighted text in dark mode." className="hidden dark:block" />
</Frame>

## Code blocks

Click the **Ask Assistant** button in a code block to open the assistant chat panel and add the code block as context. You can add multiple code blocks or text snippets to the assistant's context.
Expand All @@ -110,11 +105,6 @@ Limits:
- Maximum file size: 5 MB per attachment
- Maximum attachments per message: 10

<Frame>
<img src="/images/assistant/image-attach-light.png" alt="An image added as context in the assistant chat panel." className="block dark:hidden" />
<img src="/images/assistant/image-attach-dark.png" alt="An image added as context in the assistant chat panel." className="hidden dark:block" />
</Frame>

## Troubleshooting

<Accordion title="Assistant chat bar not visible">
Expand Down
13 changes: 2 additions & 11 deletions automations/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,11 @@ import GitlabAutomationSetup from '/snippets/gitlab-automation-setup.mdx';
- For GitHub: the [Mintlify GitHub App](/deploy/github) installed on every repository you plan to use in the automation
- For GitLab: a connected GitLab account (see [GitLab setup](#gitlab-setup) below)

<Tip>
You can also create, list, and delete automations from the terminal with [`mint automations`](/cli/commands#mint-automations). The CLI is useful for scripting and CI. The dashboard is the easiest way to configure and monitor automation runs.
</Tip>

## Enable an automation

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the toggle beside an automation to enable it.

<Frame>
<img src="/images/workflows/automations-dashboard-light.png" alt="The automations dashboard." className="block dark:hidden" />
<img src="/images/workflows/automations-dashboard-dark.png" alt="The automations dashboard." className="hidden dark:block" />
</Frame>

If the automation can run with default settings, it activates immediately. Otherwise, the automation's configure page opens so you can fill in any required configurations.
3. If the configure page opens, fill in the required fields and click **Save**.

Expand Down Expand Up @@ -125,12 +116,12 @@ When you re-enable a scheduled automation or change its schedule, Mintlify recal

## Delete an automation

Deletion is permanent and cannot be undone.

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="settings-2" /> settings button on the custom automation's card to open its configure page.
3. Click **Delete automation** at the bottom of the page and confirm.

To delete any automation from the terminal, use [`mint automations`](/cli/commands#mint-automations). Deletion is permanent and cannot be undone.

## Run an automation manually

You can trigger an automation on demand without waiting for its next scheduled or event-based run.
Expand Down
7 changes: 0 additions & 7 deletions cli/commands.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -98,13 +98,13 @@

| Client | Global configuration | Project configuration |
| --- | --- | --- |
| Claude Code | `~/.claude.json` | `.mcp.json` |

Check warning on line 101 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L101

Use 'Claude' instead of 'claude'.
| Cursor | `~/.cursor/mcp.json` | `.cursor/mcp.json` |
| VS Code | User `mcp.json` | `.vscode/mcp.json` |

Check warning on line 103 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L103

Use 'VSCode' instead of 'vscode'.
| Codex | `~/.codex/config.toml` | `.codex/config.toml` |
| OpenCode | `~/.config/opencode/opencode.json` | `opencode.json` |

Check warning on line 105 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L105

Use 'OpenCode' instead of 'opencode'.

Check warning on line 105 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L105

Use 'OpenCode' instead of 'opencode'.
| Windsurf | `~/.codeium/windsurf/mcp_config.json` | Global only |
| Zed | User `settings.json` | `.zed/settings.json` |

Check warning on line 107 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L107

Use 'Zed' instead of 'zed'.

---

Expand Down Expand Up @@ -209,7 +209,7 @@

Add the `TXT` records first, then add the `CNAME` once the verification records validate. See [Custom domain](/customize/custom-domain) for full DNS setup instructions, apex domain requirements, and TLS provisioning details.

If the command fails with `Domain is already in use by another deployment in your organization` or `Domain is already claimed by another organization`, the domain is bound to another Mintlify deployment. See [Add domain fails with "Domain is already claimed by another organization"](/help-center/domain-already-claimed-by-another-organization) to release it and re-add it.

Check warning on line 212 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L212

In general, use active voice instead of passive voice ('is bound').

<Note>
If some `TXT` records are still generating when the command exits, check the [Custom domain setup](https://app.mintlify.com/settings/project/custom-domain) page in your dashboard for the remaining values.
Expand Down Expand Up @@ -256,7 +256,7 @@

### `mint analytics stats`

Display top-line KPIs for a date range: views, visitors, searches, feedback, and assistant usage. The output reports human and agent traffic separately.

Check warning on line 259 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L259

Did you really mean 'KPIs'?

```bash
mint analytics stats [flags]
Expand Down Expand Up @@ -405,7 +405,7 @@
| `--check-redirects` | Also check that redirect destinations in `docs.json` resolve to valid paths. |
| `--check-snippets` | Also check links inside `<Snippet>` components. |

Pass `--files` to limit the check to specific pages. This is useful for validating a single page you just edited or scoping checks to a directory in CI. When `--files` is set with `--check-external`, only external URLs on the selected pages are fetched.

Check warning on line 408 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L408

In general, use active voice instead of passive voice ('are fetched').

```bash
# Check a specific page
Expand Down Expand Up @@ -482,13 +482,6 @@

Only pages in your `docs.json` navigation appear for selection.

<Frame>
<img
src="/images/cli/mint-test-scope.png"
alt="The mint test interactive interface with a steps sidebar and a page selection tree listing folders of pages with code block counts."
/>
</Frame>

### Revisit a previous run

`mint test` saves a report for each completed run. When a saved report exists, the next interactive run starts with options for it:
Expand Down Expand Up @@ -603,13 +596,13 @@
mint format
```

Run the command from the root of your docs project. It walks every subdirectory, skipping paths matched by `.gitignore` and any Mintlify ignore rules. Files that already match the canonical output are left untouched.

Check warning on line 599 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L599

In general, use active voice instead of passive voice ('are left').

<Tip>
Running `mint format` can result in many changes depending on the size of your project. To avoid merge conflicts and introducing changes to other in progress work, first resolve all important pending branches. Then create a new branch for formatting changes and run `mint format` on that branch.
</Tip>

When it finishes, the command prints how many MDX files were reformatted and how many failed to parse. If any file fails, the command exits with code `1` and prints the file path and error, so you can run it in CI to enforce consistent formatting. See [Install in CI](/cli/install#install-in-ci) for an example pipeline.

Check warning on line 605 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L605

In general, use active voice instead of passive voice ('were reformatted').

---

Expand Down Expand Up @@ -663,7 +656,7 @@

## Telemetry

The CLI collects usage telemetry to help improve Mintlify. Telemetry data includes the command name, CLI version, operating system, and architecture. If you are logged in, telemetry events also include your account email address. Logged-out usage stays anonymous, and logging out removes your stored email. Mintlify does **not** collect project content or file paths.

Check warning on line 659 in cli/commands.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

cli/commands.mdx#L659

In general, use active voice instead of passive voice ('are logged').

By default, the CLI collects telemetry data. You can opt out at any time using the `--telemetry` flag:

Expand Down
2 changes: 1 addition & 1 deletion cli/preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ You must authenticate the CLI with your Mintlify account to enable search and th
mint login
```

After you authenticate with the `mint login` command, the CLI stores your credentials in `~/.config/mintlify/config.json` so you stay logged in across sessions. The CLI also prompts you to select a default project, which commands like `mint automations` use.
After you authenticate with the `mint login` command, the CLI stores your credentials in `~/.config/mintlify/config.json` so you stay logged in across sessions. The CLI also prompts you to select a default project.

Once logged in, run `mint dev` to start the local preview with search and the assistant enabled. The assistant uses the same indexed content as your deployed documentation site.

Expand Down
6 changes: 1 addition & 5 deletions contact-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,7 @@ Visit our [YouTube](https://www.youtube.com/@GetMintlify/videos) channel for tut

## Message support

Send us a message from your [dashboard](https://app.mintlify.com/). Click the <Icon icon="headphones" /> support button in the top bar to open a support chat.

<Frame>
<img src="/images/support-button.png" alt="Support button in the top right of the dashboard." />
</Frame>
Send us a message from your [dashboard](https://app.mintlify.com/). Click <Icon icon="messages-circle" /> **Contact support** in the settings menu to open a chat with our support team.

<Info>
We aim to respond to all messages within 24 hours, but delays may occur during busy times.
Expand Down
10 changes: 0 additions & 10 deletions dashboard/sso.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -211,15 +211,9 @@ For providers other than Microsoft Entra or Okta SAML, [contact us](mailto:suppo
<Step title="Create an application">
1. In Google Workspace, navigate to **Web and mobile apps**.
2. Click **Add custom SAML app** in the **Add app** dropdown.
<Frame>
![Screenshot of the Google Workspace SAML application creation page with the "Add custom SAML app" menu item highlighted](/images/gsuite-add-custom-saml-app.png)
</Frame>
</Step>
<Step title="Send us your IdP information">
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.
<Frame>
![Screenshot of the Google Workspace SAML application page with the SSO URL, Entity ID, and x509 certificate highlighted. The specific values for each of these appear blurred.](/images/gsuite-saml-metadata.png)
</Frame>
</Step>
<Step title="Configure integration">
On the Service provider details page, enter the following:
Expand All @@ -229,10 +223,6 @@ For providers other than Microsoft Entra or Okta SAML, [contact us](mailto:suppo
* Name ID format: `EMAIL`
* Name ID: `Basic Information > Primary email`

<Frame>
![Screenshot of the Service provider details page with the ACS URL and Entity ID input fields highlighted.](/images/gsuite-sp-details.png)
</Frame>

On the next page, enter the following attribute statements:

| Google Directory Attribute | App Attribute |
Expand Down
10 changes: 1 addition & 9 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,7 @@ After completing either path, install the GitHub App by following the steps in [
You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
</Note>

Install the Mintlify GitHub App on the [Git settings](https://app.mintlify.com/settings/project/git-settings) page of your dashboard.

<Frame>
<img
className="h-80"
alt="Mintlify GitHub App installation page with the 'Only select repositories' option selected."
src="/images/github/select-repos.png"
/>
</Frame>
Install the Mintlify GitHub App on the [Git settings](https://app.mintlify.com/settings/project/git-settings) page of your dashboard. When GitHub asks which repositories to grant access to, choose **Only select repositories** and select your documentation repository.

## Permissions

Expand Down
22 changes: 0 additions & 22 deletions deploy/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@
</Step>
<Step title="Find your project ID">
In your GitLab project, navigate to **Settings** > **General** and locate your **Project ID**.
<Frame>
<img src="/images/gitlab/gitlab-project-id.png" alt="The General Settings page in the GitLab dashboard. The Project ID is highlighted." />
</Frame>
</Step>
<Step title="Generate an access token">
Navigate to **Settings** > **Access Tokens** and click **Add new token**.
Expand All @@ -49,10 +46,6 @@
<Note>
If Project Access Tokens are not available, you can use a Personal Access Token instead. Personal Access Tokens expire, so you must update them when they do.
</Note>

<Frame>
<img src="/images/gitlab/gitlab-project-access-token.png" alt="The Access tokens page in the GitLab dashboard. The settings to configure for Mintlify are highlighted." />
</Frame>
</Step>
<Step title="Connect your repository">
Back in the setup wizard, fill in the following fields:
Expand All @@ -74,7 +67,7 @@

To modify your GitLab connection settings after the initial setup, go to [Git Settings](https://app.mintlify.com/settings/project/git-settings) and update your project ID, access token, branch, or instance URL directly.

## Revalidate Git settings

Check warning on line 70 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L70

Use 'revalidat(e|es|ed|ing|ion)?' instead of 'Revalidate'.

If your deployment shows unexpected behavior, such as missing branch options or stale configuration, you can force Mintlify to refresh your Git source.

Expand All @@ -96,9 +89,6 @@
<Step title="Add new webhook">
1. In GitLab, navigate to **Settings** > **Webhooks**.
2. Click **Add new webhook**.
<Frame>
<img src="/images/gitlab/gitlab-webhook.png" alt="Screenshot of the Webhooks page in the GitLab dashboard." />
</Frame>
</Step>
<Step title="Set up URL and webhook">
Name the webhook **Mintlify**.
Expand All @@ -107,10 +97,6 @@
</Step>
<Step title="Get the webhook token">
In your Mintlify dashboard, click **Show webhook token**. Copy the webhook token.
<Frame>
<img src="/images/gitlab/show-webtoken-light.png" alt="Screenshot of the GitLab connection in the Mintlify dashboard." className="block dark:hidden" />
<img src="/images/gitlab/show-webtoken-dark.png" alt="Screenshot of the GitLab connection in the Mintlify dashboard." className="hidden dark:block" />
</Frame>
</Step>
<Step title="Paste the webhook token">
In GitLab, paste the webhook token from your Mintlify dashboard in the **Secret token** field.
Expand All @@ -129,17 +115,9 @@
- **Events**: **Push events** (All branches) and **Merge requests events**

Add the webhook.

<Frame>
<img src="/images/gitlab/gitlab-project-webtoken.png" alt="The Webhook page in the GitLab dashboard. The settings to configure for Mintlify are highlighted." />
</Frame>
</Step>
<Step title="Test the webhook">
After you create the webhook, click the **Test** dropdown. Click **Push events** to send a sample payload. If the test returns `Hook executed successfully: HTTP 200`, you configured the webhook correctly.

<Frame>
<img src="/images/gitlab/gitlab-project-webtoken-test.png" alt="Screenshot of the GitLab Webhooks page. The 'Push events' menu item is highlighted in the 'Test' menu." />
</Frame>

</Step>
</Steps>
5 changes: 0 additions & 5 deletions deploy/multi-repo.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,6 @@ One repository acts as the **base source** for the deployment. Its `docs.json` i
<Steps>
<Step title="Open Git settings">
Navigate to [Git settings](https://app.mintlify.com/settings/project/git-settings) in your dashboard.

<Frame>
<img src="/images/deployments/add-repository-light.png" alt="The Git settings page in the Mintlify dashboard. The Add repository button is visible at the bottom." className="block dark:hidden" />
<img src="/images/deployments/add-repository-dark.png" alt="The Git settings page in the Mintlify dashboard. The Add repository button is visible at the bottom." className="hidden dark:block" />
</Frame>
</Step>

<Step title="Add another repository">
Expand Down
18 changes: 2 additions & 16 deletions deploy/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,8 @@ 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 the [Activity](https://app.mintlify.com/activity) page in your dashboard.
2. Click the **Previews** tab.
3. Click the preview you want to redeploy.
4. Click **Redeploy**.

<Frame>
<img src="/images/previews/redeploy-preview-light.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="block dark:hidden" />
<img src="/images/previews/redeploy-preview-dark.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="hidden dark:block" />
</Frame>
2. Click the preview you want to redeploy.
3. Click **Redeploy**.

## Preview widget

Expand Down Expand Up @@ -95,10 +89,6 @@ Restrict preview access to authenticated members of your Mintlify organization.

1. Go to the **Previews** section of the [General](https://app.mintlify.com/settings/project/general) page in your dashboard.
2. Click the **Preview authentication** toggle to enable or disable preview authentication.
<Frame>
<img src="/images/previews/preview-auth-light.png" alt="The preview authentication toggle in the General settings page" className="block dark:hidden" />
<img src="/images/previews/preview-auth-dark.png" alt="The preview authentication toggle in the General settings page" className="hidden dark:block" />
</Frame>

### Password-protect an individual preview

Expand All @@ -109,10 +99,6 @@ Password-protect a specific preview to share it with external reviewers without
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.
<Frame>
<img src="/images/previews/private-preview-light.png" alt="The Create a custom preview modal with the Make private toggle enabled and a password field." className="block dark:hidden" />
<img src="/images/previews/private-preview-dark.png" alt="The Create a custom preview modal with the Make private toggle enabled and a password field." className="hidden dark:block" />
</Frame>
6. Click **Create preview**.

## Preview lifetime
Expand Down
Loading
Loading