Skip to content
Draft
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
29 changes: 29 additions & 0 deletions deploy/preview-deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
Preview deployments are available on [Pro and Enterprise 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 10 in deploy/preview-deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L10

Avoid using 'will'.

## Creating preview deployments

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L14

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

### Automatic previews

Expand Down Expand Up @@ -44,10 +44,39 @@
<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>

## Debugging build errors

If your preview deployment fails with a build error, you can check the logs to identify the issue.

### Viewing build logs

1. Go to your [dashboard](https://dashboard.mintlify.com/).
2. Select **Previews**.
3. Select the failed preview deployment.
4. View the build logs in the deployment details.

The logs will show specific error messages that can help you identify issues such as:

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L58

Avoid using 'will'.
- Invalid MDX syntax
- Missing files or broken links
- Configuration errors in `docs.json`
- Image or asset loading failures

### Common build errors

**Invalid MDX syntax**: Check for unclosed tags, invalid component usage, or malformed frontmatter in your MDX files.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L66

': C' should be in lowercase.

**Missing files**: Verify that all files referenced in your navigation exist and paths are correct.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L68

': V' should be in lowercase.

**Configuration errors**: Review your `docs.json` for syntax errors or invalid configuration values.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L70

': R' should be in lowercase.

**Asset errors**: Ensure all images and assets referenced in your documentation are present in your repository.

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

': E' should be in lowercase.

After fixing the issue, push your changes to trigger a new build, or manually redeploy the preview.

## Sharing preview deployments

Preview deployments can be publicly accessible or restricted to authenticated users.

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

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L80

': P' should be in lowercase.

**Restricted access**: Enable preview deployment authentication to limit preview access to authenticated Mintlify users only. See [Authentication Setup](/deploy/authentication-setup) for more information.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/preview-deployments.mdx#L82

': E' should be in lowercase.