From ece1210d6cd1b82679ba2ec1caa0c8b970523c98 Mon Sep 17 00:00:00 2001 From: "mintlify-development[bot]" <109878554+mintlify-development[bot]@users.noreply.github.com> Date: Fri, 17 Oct 2025 23:12:30 +0000 Subject: [PATCH] Update deploy/preview-deployments.mdx --- deploy/preview-deployments.mdx | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 0f59e3309..587df8567 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -44,6 +44,35 @@ Redeploy a preview to refresh content or retry after a failed deployment. The Previews menu with the deploy button emphasized by an orange rectangle. +## 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: +- 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. + +**Missing files**: Verify that all files referenced in your navigation exist and paths are correct. + +**Configuration errors**: Review your `docs.json` for syntax errors or invalid configuration values. + +**Asset errors**: Ensure all images and assets referenced in your documentation are present in your repository. + +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.