Skip to content
Closed
Changes from all commits
Commits
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
20 changes: 15 additions & 5 deletions deploy/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
Preview deployments are available on [Pro and Custom plans](https://mintlify.com/pricing?ref=preview-deployments).
</Info>

Preview deployments let you see how changes to your docs will look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes.

Check warning on line 11 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L11

Avoid using 'will'.

Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes.

## Create preview deployments

Preview deployments are created automatically through pull requests or manually from your dashboard.

Check warning on line 17 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L17

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

### Automatic previews

Expand Down Expand Up @@ -53,25 +53,35 @@

## Preview widget

The preview widget appears on preview deployments to help you navigate and review updated pages. The widget is a floating button in the bottom-right corner of your preview deployment.
The preview widget appears on preview deployments to help you navigate and review changed files. It displays as a floating button in the bottom-right corner of your preview deployment.

<Frame>
<img src="/images/previews/widget-light.png" alt="Preview widget expanded to show list of changed files." className="block dark:hidden" />
<img src="/images/previews/widget-dark.png" alt="Preview widget expanded to show list of changed files." className="hidden dark:block" />
</Frame>

1. Click the widget to show all added, modified, or removed files in the preview.
1. Click a file to view the changes on the corresponding page.
1. Use the search bar to filter the list of changed files.
### How to use the preview widget

The widget only appears on preview deployments, not on your live site or local previews.
1. Click the widget to view all files that were added, modified, or removed in the preview.

Check warning on line 65 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L65

In general, use active voice instead of passive voice ('were added').
2. Click any file to navigate directly to that page.
3. Use the search bar to filter files by path or page title.
4. Drag the widget to reposition it anywhere on the screen.

### Features

- **Status badges**: Each file displays a badge showing whether it was added, modified, or removed

Check warning on line 72 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L72

In general, use active voice instead of passive voice ('was added').
- **Search functionality**: Quickly find specific files by filtering the list

Check warning on line 73 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L73

Use 'capability' or 'feature' instead of 'functionality'.
- **Drag and drop**: Move the widget to your preferred location on the screen
- **Quick navigation**: Click any file to jump directly to that page

The widget only appears on preview deployments, not on your production site or local previews.

## Restrict access to preview deployments

By default, preview deployments are publicly accessible to anyone with the URL. You can restrict access to authenticated members of your Mintlify organization.

1. Navigate to the **Previews** section in the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard.
2. Click the **Preview authentication** toggle to enable or disable preview authentication.

Check warning on line 84 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L84

Use 'turn off' or 'off' instead of 'disable'.
<Frame>
<img src="/images/previews/preview-auth-light.png" alt="The preview authentication toggle in the Add-ons page" className="block dark:hidden" />
<img src="/images/previews/preview-auth-dark.png" alt="The preview authentication toggle in the Add-ons page" className="hidden dark:block" />
Expand Down