diff --git a/mint.json b/mint.json
index 65c9d33d9..efa8196e3 100644
--- a/mint.json
+++ b/mint.json
@@ -1,41 +1,41 @@
{
- "$schema": "https://mintlify.com/schema.json",
- "name": "Mintlify",
+ "$schema": "settings/deployment-status",
+ "name": "settings/deployment-status",
"logo": {
- "light": "/logo/light.svg",
- "dark": "/logo/dark.svg",
- "href": "https://mintlify.com"
+ "light": "settings/deployment-status",
+ "dark": "settings/deployment-status",
+ "href": "settings/deployment-status"
},
- "layout": "sidenav",
- "favicon": "/favicon.svg",
+ "layout": "settings/deployment-status",
+ "favicon": "settings/deployment-status",
"sidebar": {
- "items": "border"
+ "items": "settings/deployment-status"
},
"colors": {
- "primary": "#0D9373",
- "light": "#55D799",
- "dark": "#0D9373"
+ "primary": "settings/deployment-status",
+ "light": "settings/deployment-status",
+ "dark": "settings/deployment-status"
},
"api": {
"auth": {
- "method": "bearer"
+ "method": "settings/deployment-status"
}
},
"background": {
- "style": "windows"
+ "style": "settings/deployment-status"
},
"topbarLinks": [
{
- "name": "Community",
- "url": "https://mintlify.com/community"
+ "name": "settings/deployment-status",
+ "url": "settings/deployment-status"
}
],
"topbarCtaButton": {
- "name": "Get Started",
- "url": "https://mintlify.com/start"
+ "name": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
"codeBlock": {
- "mode": "auto"
+ "mode": "settings/deployment-status"
},
"feedback": {
"thumbsRating": true,
@@ -43,157 +43,157 @@
},
"tabs": [
{
- "name": "Components",
- "url": "content"
+ "name": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "name": "Integrations",
- "url": "integrations"
+ "name": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "name": "Changelog",
- "url": "changelog"
+ "name": "settings/deployment-status",
+ "url": "settings/deployment-status"
}
],
"navigation": [
{
- "group": "Getting Started",
+ "group": "settings/deployment-status",
"pages": [
- "quickstart",
+ "settings/deployment-status",
{
- "group": "Editing",
- "icon": "pen-paintbrush",
+ "group": "settings/deployment-status",
+ "icon": "settings/deployment-status",
"pages": [
- "development",
- "web-editor"
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
- "settings/global",
- "settings/navigation",
- "migration"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Writing Content",
+ "group": "settings/deployment-status",
"pages": [
- "page",
- "text",
- "image-embeds",
- "list-table",
- "code",
- "reusable-snippets"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "API References",
+ "group": "settings/deployment-status",
"pages": [
- "api-playground/overview",
+ "settings/deployment-status",
{
- "group": "OpenAPI",
- "icon": "brackets-curly",
+ "group": "settings/deployment-status",
+ "icon": "settings/deployment-status",
"pages": [
- "api-playground/openapi/setup",
- "api-playground/openapi/writing-openapi",
- "api-playground/openapi/advanced-features"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "MDX",
- "icon": "markdown",
+ "group": "settings/deployment-status",
+ "icon": "settings/deployment-status",
"pages": [
- "api-playground/mdx/configuration",
- "api-playground/mdx/authentication"
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
- "api-playground/troubleshooting"
+ "settings/deployment-status"
]
},
{
- "group": "Configurations",
+ "group": "settings/deployment-status",
"pages": [
- "settings/custom-domain",
- "settings/seo",
- "settings/broken-links",
- "settings/versioning",
- "settings/add-members",
- "settings/github",
- "settings/gitlab",
- "settings/preview-deployments"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Advanced",
+ "group": "settings/deployment-status",
"pages": [
{
- "icon": "code",
- "group": "Custom Scripts",
+ "icon": "settings/deployment-status",
+ "group": "settings/deployment-status",
"pages": [
- "advanced/custom/css",
- "advanced/custom/js"
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "icon": "folder",
- "group": "Custom Subdirectory",
+ "icon": "settings/deployment-status",
+ "group": "settings/deployment-status",
"pages": [
- "advanced/subpath/cloudflare",
- "advanced/subpath/route53-cloudfront",
- "advanced/subpath/vercel"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "icon": "user-lock",
- "group": "Auth & Personalization",
+ "icon": "settings/deployment-status",
+ "group": "settings/deployment-status",
"pages": [
- "settings/authentication-personalization/authentication",
- "settings/authentication-personalization/personalization",
- "settings/authentication-personalization/authentication-vs-personalization",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
{
- "group": "Authentication Setup",
+ "group": "settings/deployment-status",
"pages": [
- "settings/authentication-personalization/authentication-setup/choosing-a-handshake",
- "settings/authentication-personalization/authentication-setup/password",
- "settings/authentication-personalization/authentication-setup/jwt",
- "settings/authentication-personalization/authentication-setup/oauth",
- "settings/authentication-personalization/authentication-setup/mintlify"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Personalization Setup",
+ "group": "settings/deployment-status",
"pages": [
- "settings/authentication-personalization/personalization-setup/choosing-a-handshake",
- "settings/authentication-personalization/personalization-setup/shared-session",
- "settings/authentication-personalization/personalization-setup/jwt",
- "settings/authentication-personalization/personalization-setup/oauth"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
- "settings/authentication-personalization/sending-data"
+ "settings/deployment-status"
]
},
{
- "icon": "plug",
- "group": "Extensions",
+ "icon": "settings/deployment-status",
+ "group": "settings/deployment-status",
"pages": [
- "advanced/widget/chat"
+ "settings/deployment-status"
]
},
{
- "icon": "brackets-curly",
- "group": "REST API",
+ "icon": "settings/deployment-status",
+ "group": "settings/deployment-status",
"pages": [
- "advanced/rest-api/overview",
+ "settings/deployment-status",
{
- "group": "Updates",
+ "group": "settings/deployment-status",
"pages": [
- "advanced/rest-api/update/trigger",
- "advanced/rest-api/update/status"
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Discovery API",
+ "group": "settings/deployment-status",
"pages": [
- "advanced/rest-api/discovery/create-topic",
- "advanced/rest-api/discovery/generate-message"
+ "settings/deployment-status",
+ "settings/deployment-status"
]
}
]
@@ -201,149 +201,149 @@
]
},
{
- "group": "Analytics",
+ "group": "settings/deployment-status",
"pages": [
- "integrations/analytics/overview",
- "integrations/analytics/amplitude",
- "integrations/analytics/clearbit",
- "integrations/analytics/fathom",
- "integrations/analytics/google-analytics",
- "integrations/analytics/google-tag-manager",
- "integrations/analytics/heap",
- "integrations/analytics/hotjar",
- "integrations/analytics/koala",
- "integrations/analytics/logrocket",
- "integrations/analytics/mixpanel",
- "integrations/analytics/pirsch",
- "integrations/analytics/plausible",
- "integrations/analytics/posthog"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "SDKs",
+ "group": "settings/deployment-status",
"pages": [
- "integrations/sdks/speakeasy",
- "integrations/sdks/stainless"
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Support",
+ "group": "settings/deployment-status",
"pages": [
- "integrations/support/overview",
- "integrations/support/intercom",
- "integrations/support/front"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Privacy",
+ "group": "settings/deployment-status",
"pages": [
- "integrations/privacy/overview",
- "integrations/privacy/osano"
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Components",
+ "group": "settings/deployment-status",
"pages": [
- "content/components/accordions",
- "content/components/accordion-groups",
- "content/components/callouts",
- "content/components/cards",
- "content/components/card-groups",
- "content/components/code",
- "content/components/code-groups",
- "content/components/frames",
- "content/components/icons",
- "content/components/mermaid-diagrams",
- "content/components/steps",
- "content/components/tabs",
- "content/components/tooltips",
- "content/components/update"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "API Components",
+ "group": "settings/deployment-status",
"pages": [
- "content/components/params",
- "content/components/responses",
- "content/components/expandables",
- "content/components/sticky-examples"
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status",
+ "settings/deployment-status"
]
},
{
- "group": "Changelog",
+ "group": "settings/deployment-status",
"pages": [
- "changelog/overview"
+ "settings/deployment-status"
]
}
],
"footer": {
"socials": {
- "x": "https://x.com/mintlify",
- "linkedin": "https://www.linkedin.com/company/mintlify",
- "github": "https://github.com/mintlify",
- "slack": "https://mintlify.com/community"
+ "x": "settings/deployment-status",
+ "linkedin": "settings/deployment-status",
+ "github": "settings/deployment-status",
+ "slack": "settings/deployment-status"
},
"links": [
{
- "title": "Resources",
+ "title": "settings/deployment-status",
"links": [
{
- "label": "Customers",
- "url": "https://mintlify.com/customers"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Enterprise",
- "url": "https://mintlify.com/enterprise"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Request Preview",
- "url": "https://mintlify.com/preview"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Integrations",
- "url": "https://mintlify.com/docs/integrations/analytics/overview"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Templates",
- "url": "https://github.com/mintlify/themes"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Wall of Love",
- "url": "https://mintlify.com/love"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
}
]
},
{
- "title": "Company",
+ "title": "settings/deployment-status",
"links": [
{
- "label": "Careers",
- "url": "https://mintlify.com/careers"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Blog",
- "url": "https://mintlify.com/blog"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Public Roadmap",
- "url": "https://feedback.mintlify.com/roadmap"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Security",
- "url": "https://mintlify.com/security/responsible-disclosure"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
}
]
},
{
- "title": "Legal",
+ "title": "settings/deployment-status",
"links": [
{
- "label": "Privacy Policy",
- "url": "https://mintlify.com/legal/privacy"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
},
{
- "label": "Terms of Service",
- "url": "https://mintlify.com/legal/terms"
+ "label": "settings/deployment-status",
+ "url": "settings/deployment-status"
}
]
}
@@ -351,10 +351,10 @@
},
"analytics": {
"ga4": {
- "measurementId": "G-RCYWHL7EQ7"
+ "measurementId": "settings/deployment-status"
},
"koala": {
- "publicApiKey": "pk_76a6caa274e800f3ceff0b2bc6b9b9d82ab8"
+ "publicApiKey": "settings/deployment-status"
}
}
}
\ No newline at end of file
diff --git a/settings/deployment-status.mdx b/settings/deployment-status.mdx
new file mode 100644
index 000000000..c0322a7d6
--- /dev/null
+++ b/settings/deployment-status.mdx
@@ -0,0 +1,106 @@
+---
+title: "Deployment Status"
+description: "Track the status of your documentation deployments"
+icon: "circle-check"
+---
+
+Mintlify integrates with your source control provider to give you visibility into the status of your documentation deployments. This helps you verify that your changes have been successfully published.
+
+## GitHub Checks
+
+When you push changes to your repository, Mintlify automatically creates a check on your commit to indicate the deployment status.
+
+### Successful Deployment
+
+If the deployment is successful, you should see the following:
+
+
+
+
+
+### Failed Deployment
+
+If there are any issues with the deployment, the check will fail and include details about what went wrong:
+
+
+
+
+
+## Preview Deployment Comments
+
+When you create a pull request, Mintlify will automatically create a preview deployment and add a comment with the preview URL. This allows you to preview your changes before merging them into production.
+
+
+ Preview deployments are available on the Growth and Enterprise plans. Learn more about preview deployments in our [Preview Deployments guide](/settings/preview-deployments).
+
+
+The comment will include:
+- A unique preview URL for your changes
+- The deployment status
+- Any error messages if the deployment failed
+
+## Troubleshooting Failed Deployments
+
+If your deployment fails, here are some common issues and how to resolve them:
+
+
+
+ The most common cause of failed deployments is invalid configuration in your `mint.json` file. Verify that:
+ - All required fields are present
+ - The JSON is properly formatted
+ - All file paths referenced exist
+
+
+
+ Ensure that:
+ - The Mintlify GitHub app is properly installed and has access to your repository
+ - You have the necessary permissions to deploy to the repository
+ - Your account has been properly authenticated with Mintlify
+
+
+
+ If your deployment fails during build:
+ - Check for any MDX syntax errors in your content
+ - Verify that all images and assets are properly referenced
+ - Review the error messages in the GitHub check for specific details
+
+
+
+## Manual Status Check
+
+You can also manually check the status of your latest deployment through the Mintlify dashboard:
+
+
+
+ Go to your [Mintlify dashboard](https://dashboard.mintlify.com)
+
+
+ Choose the project you want to check
+
+
+ Under the "Deployments" section, you'll see:
+ - Latest deployment status
+ - Timestamp of last successful deployment
+ - Any error messages from failed deployments
+
+
+
+
+ If you need to trigger a manual update, you can do so through the dashboard's "Manual Update" button.
+
+
+## GitLab Integration
+
+For GitLab repositories, Mintlify provides similar deployment status indicators through:
+- Pipeline status badges
+- Merge request comments
+- Deployment status in the GitLab UI
+
+The deployment status workflow is similar to GitHub, but appears in GitLab-specific locations within the UI.
+
+
+ Need help troubleshooting a failed deployment? Contact us at [support@mintlify.com](mailto:support@mintlify.com)
+
\ No newline at end of file