From aff3f426cc433bb0d9fd1acec7442024b21534e9 Mon Sep 17 00:00:00 2001 From: Mintlify Agent Date: Tue, 10 Feb 2026 23:50:45 +0000 Subject: [PATCH] Add rainbow text styling to all deployment occurrences in English docs - Created custom RainbowText component with gradient styling - Applied rainbow effect to all instances of 'deployment' word in English documentation - Updated 34 files across deploy/, guides/, editor/, api/, and other sections - Maintained accessibility and readability while adding visual emphasis --- ai/slack-bot.mdx | 4 +++- api/introduction.mdx | 4 +++- api/update/status.mdx | 4 +++- api/update/trigger.mdx | 4 +++- changelog.mdx | 34 +++++++++++++++------------- customize/custom-domain.mdx | 4 +++- dashboard/audit-logs.mdx | 4 +++- dashboard/permissions.mdx | 8 ++++--- deploy/ci.mdx | 8 ++++--- deploy/deployments.mdx | 24 +++++++++++--------- deploy/ghes.mdx | 8 ++++--- deploy/github.mdx | 22 ++++++++++-------- deploy/gitlab.mdx | 4 +++- deploy/monorepo.mdx | 6 +++-- deploy/preview-deployments.mdx | 20 ++++++++-------- deploy/reverse-proxy.mdx | 8 ++++--- deploy/route53-cloudfront.mdx | 4 +++- deploy/vercel-external-proxies.mdx | 8 ++++--- deploy/vercel.mdx | 8 ++++--- editor/collaborate.mdx | 6 +++-- editor/index.mdx | 4 +++- editor/live-preview.mdx | 4 +++- editor/publish.mdx | 14 +++++++----- guides/branches.mdx | 8 ++++--- guides/git-concepts.mdx | 22 ++++++++++-------- guides/internationalization.mdx | 4 +++- guides/knowledge-base.mdx | 6 +++-- installation.mdx | 8 ++++--- optimize/pdf-exports.mdx | 4 +++- organize/navigation.mdx | 4 +++- quickstart.mdx | 10 ++++---- skill.md | 4 +++- snippets/components/rainbow-text.mdx | 13 +++++++++++ status.mdx | 4 +++- 34 files changed, 190 insertions(+), 111 deletions(-) create mode 100644 snippets/components/rainbow-text.mdx diff --git a/ai/slack-bot.mdx b/ai/slack-bot.mdx index 5044c91e0..dba7c70d4 100644 --- a/ai/slack-bot.mdx +++ b/ai/slack-bot.mdx @@ -4,6 +4,8 @@ description: "Add a bot to your Slack workspace that answers questions based on keywords: ["bot", "workspace", "Q&A", "Slack", "app"] --- + + The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app) with access to the assistant. @@ -19,7 +21,7 @@ Each message sent by the bot counts toward your assistant message usage. ## Set up the Slack app - You can only install the Slack app once per workspace. If you have multiple Mintlify deployments, you can only connect one deployment at a time to a workspace. You must disconnect the app from one deployment before connecting it to another. + You can only install the Slack app once per workspace. If you have multiple Mintlify deployments, you can only connect one deployment at a time to a workspace. You must disconnect the app from one deployment before connecting it to another. If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it. diff --git a/api/introduction.mdx b/api/introduction.mdx index 50480703b..dc0767a00 100644 --- a/api/introduction.mdx +++ b/api/introduction.mdx @@ -4,6 +4,8 @@ description: "Trigger updates, embed AI assistant, export analytics, and more" keywords: ["REST API", "endpoints", "API keys"] --- + + The Mintlify REST API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data. ## Endpoints @@ -21,7 +23,7 @@ The Mintlify REST API enables you to programmatically interact with your documen ### Common use cases - **Automated deployments**: Trigger site updates at set intervals or when events occur with [Trigger update](/api/update/trigger) and [Get update status](/api/update/status). -- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger). +- **CI/CD integration**: Update documentation as part of your deployment pipeline when code changes with [Trigger update](/api/update/trigger). - **Custom integrations**: Embed the AI assistant into your product, support portal, or internal tools with [Generate assistant message](/api/assistant/create-assistant-message) and [Search documentation](/api/assistant/search). - **Automated editing**: Use agent jobs to programmatically update documentation at scale with [Create agent job](/api/agent/create-agent-job), [Get agent job](/api/agent/get-agent-job), and [Get all agent jobs](/api/agent/get-all-jobs). - **Analytics export**: Export feedback and assistant conversations for external analysis with [Get user feedback](/api/analytics/feedback) and [Get assistant conversations](/api/analytics/assistant-conversations). diff --git a/api/update/status.mdx b/api/update/status.mdx index a29a23aee..692b7e0cd 100644 --- a/api/update/status.mdx +++ b/api/update/status.mdx @@ -1,4 +1,6 @@ --- openapi: "/openapi.json GET /project/update-status/{statusId}" -keywords: [ "update status", "deployment status", "check status" ] +keywords: [ "update status", "deployment status", "check status" ] --- + + diff --git a/api/update/trigger.mdx b/api/update/trigger.mdx index 2c2158730..b0e9aaaf8 100644 --- a/api/update/trigger.mdx +++ b/api/update/trigger.mdx @@ -1,4 +1,6 @@ --- openapi: "/openapi.json POST /project/update/{projectId}" -keywords: [ "trigger", "update", "deployment", "programmatic" ] +keywords: [ "trigger", "update", "deployment", "programmatic" ] --- + + diff --git a/changelog.mdx b/changelog.mdx index 46a113906..9e7db65eb 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -5,6 +5,8 @@ rss: true noindex: true --- + + ## Self-serve SSO configuration @@ -114,12 +116,12 @@ noindex: true ## Web editor improvements - - **Live preview**: See real-time changes as you edit your documentation in the web editor. Live previews show your site exactly as it appears when published, without creating a preview deployment. + - **Live preview**: See real-time changes as you edit your documentation in the web editor. Live previews show your site exactly as it appears when published, without creating a preview deployment. - **Unused files section**: The editor now shows unused pages that aren't in your navigation, with drag-and-drop support to add them. ## Branch search for Git integrations - Added branch search functionality for GitHub and GitLab integrations so that it is easier to find and switch between deployment branches in the Git settings of your dashboard. + Added branch search functionality for GitHub and GitLab integrations so that it is easier to find and switch between deployment branches in the Git settings of your dashboard. ## `mintlify validate` CLI command @@ -251,7 +253,7 @@ noindex: true ## Improvements - **Insights** renamed to **Analytics** in the dashboard. - - Added ability to delete a deployment from the dashboard. + - Added ability to delete a deployment from the dashboard. - The `Tooltip` component has been redesigned with improved styling and now supports an optional `headline` prop for adding a title to your tooltips. - The `mint a11y` command now supports `--skip-contrast` and `--skip-alt-text` flags, allowing you to run specific accessibility checks in your CI/CD pipeline. Use `--skip-contrast` to check only for missing alt text, or `--skip-alt-text` to check only color contrast ratios. @@ -273,7 +275,7 @@ noindex: true ## Preview widget - Preview deployments now include an interactive widget that displays all changed files in the deployment. The widget appears as a floating button in the bottom-right corner and provides: + Preview deployments now include an interactive widget that displays all changed files in the deployment. The widget appears as a floating button in the bottom-right corner and provides: - One-click navigation to changed pages. - Searchable list of all changed files with status badges (added, modified, removed). @@ -482,9 +484,9 @@ noindex: true - Fixed props adjacent to `$refs` and `x-` props getting lost in OpenAPI parsing - Fixed API playground modal header styling - ## Web editor and deployment enhancements + ## Web editor and deployment enhancements - - Restored manual create preview button for easier preview deployment creation + - Restored manual create preview button for easier preview deployment creation - Added fetcher in dashboard for branch protections data - Added fetcher in dashboard for PR status tracking - Improved editor state management, enabling state to persist across browser sessions @@ -567,7 +569,7 @@ noindex: true - Removed background from code blocks in editor for cleaner appearance - Fixed branch creation workflow to correctly navigate to newly created branches - - Added deployment history pagination + - Added deployment history pagination - Added cursor pagination to preview deployments table - Fixed preview deployments to only return preview environment deployments - Improved dashboard UI/UX with better spacing, input handling, and layout fixes @@ -680,7 +682,7 @@ noindex: true ## Bug fixes and reliability - Fixed GitLab integration issues with larger repositories - - Improved dashboard loading performance with optimized deployment queries + - Improved dashboard loading performance with optimized deployment queries - Fixed SVG path rendering issues in documentation - Fixed keyboard navigation in search and chat functionality @@ -704,7 +706,7 @@ noindex: true - Security enhancement added to editor such that only users with `write permissions` for the connected git hosting repository can make changes - Fixed a bug where preview deployments wouldn't work for branches with `=` in the name - - Fixed a bug where long branch names would overflow modals on preview deployment creations + - Fixed a bug where long branch names would overflow modals on preview deployment creations - Quality of life improvement where email query parameter will prefill the input on signup invitations - Fixed a bug where copying a page from the context menu was not working on safari @@ -765,11 +767,11 @@ noindex: true - **Major improvement**: Images no longer cause layout shift by default, even when width and height attributes aren't specified—automatic sizing prevents content jumping during page loads - All static files in your repository (PDF, TXT, XML, etc.) are now automatically uploaded and served when you deploy, providing complete asset coverage - ## Web editor and deployment enhancements + ## Web editor and deployment enhancements - Fixed branch creation workflow in web editor to correctly navigate to and stay on newly created branches - Enhanced merge conflict dialog with proper escape functionality, no more page reloads required to dismiss conflicts - - Optimized update workflow performance by cache-invalidating only changed pages during partial updates, reducing deployment times + - Optimized update workflow performance by cache-invalidating only changed pages during partial updates, reducing deployment times ## Authentication and navigation improvements @@ -792,9 +794,9 @@ noindex: true ## Performance and build optimizations - - MDX transpilation now happens at deployment time instead of on every page load in uncached NextJS serverless environments, improving time to first byte for uncached pages. + - MDX transpilation now happens at deployment time instead of on every page load in uncached NextJS serverless environments, improving time to first byte for uncached pages. - Content-based hashing prevents re-transpilation when MDX hasn't changed, reducing update workflow times by ~50% for customers with large page counts (deployments over 5 minutes should be roughly halved) - - Preview deployment viewing in the dashboard is now faster with added database indexes and query parallelization in our backend + - Preview deployment viewing in the dashboard is now faster with added database indexes and query parallelization in our backend - Reduced page size by eliminating duplicate `navigation` data in each page's `rsc` payload—performance gains most noticeable with high page counts or complex navigation structures - More aggressive prefetching enables instant page loads more frequently @@ -1031,7 +1033,7 @@ noindex: true - Tag changelog updates so end users can filter updates - Sonnet-3.7 supported for AI Chat. Configure your preferred model through the dashboard - - Change your deployment name directly in dashboard settings + - Change your deployment name directly in dashboard settings ## Bug fixes @@ -1228,7 +1230,7 @@ noindex: true - Consolidated the login and signup pages to decrease friction and confusion. - Implemented the discovery login flow so that users that are members of multiple organizations can now switch between them. - Added login with Google OAuth - - Added ability to add new deployment through dashboard settings. + - Added ability to add new deployment through dashboard settings. ## Bug Fixes @@ -1397,4 +1399,4 @@ noindex: true - Snippets V2: We now support fully reusable components and variables for snippets. - Open-source MDX Engine: We've exposed two APIs—getCompiledMdx and MDXComponent—so you can access Mintlify markdown and code syntax highlighting. [Contributions to the project](https://github.com/mintlify/mdx) are welcome. - AI Chat Insights: Segment chat history by date and increase AI Chat quota from the dashboard, and see how often a specific query appears. - \ No newline at end of file + diff --git a/customize/custom-domain.mdx b/customize/custom-domain.mdx index 365ffc55c..a26a489ca 100644 --- a/customize/custom-domain.mdx +++ b/customize/custom-domain.mdx @@ -5,6 +5,8 @@ og:description: "Host your documentation on a custom domain." keywords: ["custom domain setup", "DNS configuration", "CNAME records", "TLS certificates"] --- + + To host your documentation on a custom domain: 1. Add your domain in your dashboard. 2. Configure DNS settings on your domain provider. @@ -16,7 +18,7 @@ To host your documentation on a custom domain: ## Add your custom domain -1. Navigate to the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +1. Navigate to the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. 2. Enter your domain name. For example, `docs.example.com` or `www.example.com`. 3. Click **Add domain**. diff --git a/dashboard/audit-logs.mdx b/dashboard/audit-logs.mdx index c13cab134..edbe83e01 100644 --- a/dashboard/audit-logs.mdx +++ b/dashboard/audit-logs.mdx @@ -4,6 +4,8 @@ description: "Review the actions that members of your organization perform." keywords: ["monitoring", "activity tracking", "security", "compliance"] --- + + Audit logs are available on [Enterprise plans](https://mintlify.com/pricing?ref=audit-logs). @@ -43,7 +45,7 @@ Filter audit logs to find specific activities. | Organization | Organization settings updates and deletion requests. | | Member | Team member invitations, removals, and role changes. | | Deployment | Deployment configuration changes including custom domains, authentication, and Git sources. | -| Preview deployment | Preview deployment creation, updates, and authentication changes. | +| Preview deployment | Preview deployment creation, updates, and authentication changes. | | API key | API key and discovery API key creation and deletion. | | Assistant | Assistant setting updates like deflection email, web search sites, and starter questions. | | PDF export | PDF export generation and deletion. | diff --git a/dashboard/permissions.mdx b/dashboard/permissions.mdx index d3ce45429..2a5fafc6c 100644 --- a/dashboard/permissions.mdx +++ b/dashboard/permissions.mdx @@ -1,9 +1,11 @@ --- title: "Deployment permissions" -description: "Understand deployment differences between people in your organization and other contributors." -keywords: ["editor access", "permissions", "team", "seats", "deployment"] +description: "Understand deployment differences between people in your organization and other contributors." +keywords: ["editor access", "permissions", "team", "seats", "deployment"] --- + + People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically. -Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard. +Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard. diff --git a/deploy/ci.mdx b/deploy/ci.mdx index d5483fb3d..29518f3cc 100644 --- a/deploy/ci.mdx +++ b/deploy/ci.mdx @@ -4,11 +4,13 @@ description: "Automate broken link checks, linting, and grammar validation in CI keywords: ["continuous integration", "CI/CD", "checks", "Vale", "linter"] --- + + [Pro and Enterprise plans](https://mintlify.com/pricing?ref=docs-ci) include CI checks for GitHub repositories. -Use CI checks to lint your docs for errors and provide warnings before you deploy. Mintlify CI checks run on pull requests against a configured deployment branch. +Use CI checks to lint your docs for errors and provide warnings before you deploy. Mintlify CI checks run on pull requests against a configured deployment branch. ## Installation @@ -20,7 +22,7 @@ To begin, follow the steps on the [GitHub](/deploy/github) page. ## Configuration -Configure the CI checks enabled for a deployment by navigating to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard. Enable the checks that you want to run. +Configure the CI checks enabled for a deployment by navigating to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard. Enable the checks that you want to run. When enabling checks, you can choose to run them at a `Warning` or `Blocking` level. @@ -43,7 +45,7 @@ To see the results of this check, visit GitHub's check results page for a specif Mintlify supports automatically running Vale in a CI check and displaying the results as a check status. #### Configuration -If you have a `.vale.ini` file in the root content directory of your deployment, the Vale CI check uses that configuration file and any configuration files in your specified `stylesPath`. +If you have a `.vale.ini` file in the root content directory of your deployment, the Vale CI check uses that configuration file and any configuration files in your specified `stylesPath`. If you don't have a Vale config file, the default configuration automatically loads. diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index eb1285266..80217964e 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -1,22 +1,24 @@ --- title: "Deployments" description: "Manage deployments, view history, and monitor status." -keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] +keywords: ["manual deployment", "deployment history", "deployment triggers", "delete deployment"] --- + + Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected. If your latest changes are not appearing on your live site, first check that the GitHub account or organization that owns your docs repository has the GitHub App installed. See [GitHub troubleshooting](/deploy/github#troubleshooting) for more information. -If you have the GitHub App installed, but changes are still not deploying, manually trigger a deployment from your dashboard. +If you have the GitHub App installed, but changes are still not deploying, manually trigger a deployment from your dashboard. -## Manually trigger a deployment +## Manually trigger a deployment Check that your latest commit appears in your docs repository and did not encounter any errors. - + Go to your [dashboard](https://dashboard.mintlify.com) and select the deploy button. The manual update button emphasized with an orange rectangle. @@ -25,22 +27,22 @@ If you have the GitHub App installed, but changes are still not deploying, manua -## Delete a deployment +## Delete a deployment -You can permanently delete a deployment from the [Danger zone](https://dashboard.mintlify.com/settings/organization/danger-zone) in your dashboard settings. This action is irreversible and removes all deployment data, including any associated preview deployments. +You can permanently delete a deployment from the [Danger zone](https://dashboard.mintlify.com/settings/organization/danger-zone) in your dashboard settings. This action is irreversible and removes all deployment data, including any associated preview deployments. Go to the [Danger zone](https://dashboard.mintlify.com/settings/organization/danger-zone) in the settings page of your dashboard. - - 1. In the **Delete my deployment** section, provide a reason for deletion. - 2. Click the delete button and confirm that you want to delete the deployment. + + 1. In the **Delete my deployment** section, provide a reason for deletion. + 2. Click the delete button and confirm that you want to delete the deployment. - Deleting a deployment is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period. + Deleting a deployment is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period. -If you have multiple deployments, you'll be redirected to another deployment after deletion. If you delete your only deployment, you'll be redirected to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion. +If you have multiple deployments, you'll be redirected to another deployment after deletion. If you delete your only deployment, you'll be redirected to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion. diff --git a/deploy/ghes.mdx b/deploy/ghes.mdx index a5e13c7fb..b1832df33 100644 --- a/deploy/ghes.mdx +++ b/deploy/ghes.mdx @@ -4,6 +4,8 @@ description: "Set up the GitHub App on your GitHub Enterprise Server installatio keywords: ["GitHub Enterprise Server", "GHES", "GitHub Enterprise"] --- + + This guide walks you through setting up the Mintlify GitHub App on your GitHub Enterprise Server (GHES) installation. To connect a GHES instance to Mintlify, you must create a local version of our app within your self-hosted environment that communicates with our remote server. If you use a cloud-hosted GitHub instance, see the [GitHub](/deploy/github) page for setup instructions. @@ -169,10 +171,10 @@ Please share the following information with our team using your secure informati ## Mintlify connection We take the credentials you provide us and store them, encrypted, in a secure location. Then we work with you to either: -- Integrate your GHES environment with an existing Mintlify deployment. -- Integrate your GHES environment with a new Mintlify deployment that we provision for you. +- Integrate your GHES environment with an existing Mintlify deployment. +- Integrate your GHES environment with a new Mintlify deployment that we provision for you. -After your GHES environment is integrated with a Mintlify deployment, you are ready to enable webhooks for your GitHub App. +After your GHES environment is integrated with a Mintlify deployment, you are ready to enable webhooks for your GitHub App. The webhook URL may change based on our configuration. We test the integration and provide you with the new URL. diff --git a/deploy/github.mdx b/deploy/github.mdx index 83bd8d027..9de7aceac 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -4,6 +4,8 @@ description: "Connect to a GitHub repository for automated deployments, pull req keywords: ["GitHub App","repository connection","automated deployments"] --- + + Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository. @@ -12,7 +14,7 @@ Mintlify uses a GitHub App to automatically sync your documentation with your Gi - **Mintlify-hosted repository** in the `mintlify-community` organization: No. The GitHub App is already configured. - **Your own repository**: Yes. Install the GitHub App to enable automatic deployments when you push changes. - See your repository in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. + See your repository in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. If your repository is in a private repository owned by the Mintlify organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, clone the repository to your own organization and update your Git settings to use your own repository. @@ -21,7 +23,7 @@ If your repository is in a private repository owned by the Mintlify organization If you skipped connecting your own Git repository during onboarding, your documentation lives in a private repository owned by the Mintlify organization. To move it to your own account or organization: -1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. +1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. 2. Click **Clone as Private** or **Clone as Public**. Public repos allow anyone to view your documentation source and submit issues or suggestions. Private repos restrict access to your team. 3. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below. @@ -29,11 +31,11 @@ If you skipped connecting your own Git repository during onboarding, your docume If you want a private repository without granting elevated OAuth permissions, you can manually transfer your documentation: -1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. +1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. 2. Download your documentation as a zip file. 3. Create a new repository on GitHub or GitLab. 4. Extract the zip contents and push them to your new repository. -5. Return to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and connect your new repository to Mintlify. +5. Return to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and connect your new repository to Mintlify. 6. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below. ## Install the GitHub App @@ -81,7 +83,7 @@ When installing the GitHub App, you can grant access to all of your repositories ## Configure docs source -Change the organization, repository, or branch that your documentation builds from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard. +Change the organization, repository, or branch that your documentation builds from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard. ## GitHub Enterprise with IP allowlists @@ -102,10 +104,10 @@ If pushes to your repository don't trigger deployments, check the following poss 1. Go to [GitHub App settings](https://dashboard.mintlify.com/settings/organization/github-app) in your dashboard. 1. Check that your repository is on the active app installations list. - + Ensure that you're pushing to the correct branch. - 1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) + 1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) 1. Verify the branch in your dashboard matches the branch that you're pushing to. @@ -120,7 +122,7 @@ If you encounter problems with the GitHub app, resetting the connection can solv 2. Go to [Authorized GitHub Apps](https://github.com/settings/apps/authorizations) and select **Revoke** next to the Mintlify app. - 1. In your Mintlify dashboard, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and install the GitHub app. + 1. In your Mintlify dashboard, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and install the GitHub app. 2. Authorize your account in the [My Profile](https://dashboard.mintlify.com/settings/account) section of your dashboard. @@ -133,7 +135,7 @@ If your repository is public and you cannot enable the edit suggestions or raise - Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. + Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. Click the green check mark in the corner of the Git settings box to revalidate your repository settings. This forces an update to your repository settings to reflect whether your repository is public or private. @@ -152,4 +154,4 @@ If your repository is public and you cannot enable the edit suggestions or raise /> - \ No newline at end of file + diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index eccbd3c45..9b19c3cbd 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -4,6 +4,8 @@ description: "Connect to a GitLab repository for automated deployments and previ keywords: ["GitLab integration", "access tokens", "merge request previews"] --- + + We use access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify. - Mintlify uses access tokens to pull information from GitLab. @@ -42,7 +44,7 @@ We use access tokens and webhooks to authenticate and sync changes between GitLa - In the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings): + In the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings): 1. Enter your project ID and access token. 2. Complete any other required configurations. 3. Click **Save Changes**. diff --git a/deploy/monorepo.mdx b/deploy/monorepo.mdx index 512499963..bd1d35993 100644 --- a/deploy/monorepo.mdx +++ b/deploy/monorepo.mdx @@ -4,6 +4,8 @@ description: "Configure documentation path and content directory for monorepo pr keywords: ["monorepo", "content directory", "multi-project repository"] --- + + Configure Mintlify to deploy documentation from a specific directory within a monorepo. This setup allows you to maintain documentation alongside your code in repositories that contain multiple projects or services. ## Prerequisites @@ -12,11 +14,11 @@ Configure Mintlify to deploy documentation from a specific directory within a mo * Documentation files organized in a dedicated directory within your monorepo. * A valid `docs.json` in your documentation directory. -## Configure monorepo deployment +## Configure monorepo deployment -Navigate to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. +Navigate to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard. + Preview deployments are available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). @@ -19,14 +21,14 @@ Preview deployments are created automatically through pull requests or manually ### Automatic previews - Automatic previews are only created for pull requests targeting your [deployment branch](/guides/git-concepts#deployment-branch). + Automatic previews are only created for pull requests targeting your [deployment branch](/guides/git-concepts#deployment-branch). -When you create a pull request, the Mintlify bot automatically adds a link to view the preview deployment in your pull request. The preview updates each time you push new commits to the branch. +When you create a pull request, the Mintlify bot automatically adds a link to view the preview deployment in your pull request. The preview updates each time you push new commits to the branch. - Link to view deployment in the pull request timeline - Link to view deployment in the pull request timeline + Link to view <RainbowText>deployment</RainbowText> in the pull request timeline + Link to view <RainbowText>deployment</RainbowText> in the pull request timeline ### Manual previews @@ -37,11 +39,11 @@ You can manually create a preview for any branch. 2. Select **Previews**. 3. Select **Create custom preview**. 4. Enter the name of the branch you want to preview. -5. Select **Create deployment**. +5. Select **Create deployment**. ## Redeploy a preview -Redeploy a preview to refresh content or retry after a failed deployment. +Redeploy a preview to refresh content or retry after a failed deployment. 1. Select the preview from your [dashboard](https://dashboard.mintlify.com/). 2. Select **Redeploy**. @@ -53,7 +55,7 @@ Redeploy a preview to refresh content or retry after a failed deployment. ## 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 updated pages. The widget is a floating button in the bottom-right corner of your preview deployment. Preview widget expanded to show list of changed files. @@ -79,9 +81,9 @@ By default, preview deployments are publicly accessible to anyone with the URL. ## Troubleshooting preview deployments -If your preview deployment fails, try these troubleshooting steps. +If your preview deployment fails, try these troubleshooting steps. -- **View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures. +- **View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures. - **Check your configuration**: - Invalid `docs.json` syntax - Missing or incorrect file paths referenced in your navigation diff --git a/deploy/reverse-proxy.mdx b/deploy/reverse-proxy.mdx index 1bcd67912..897585d2a 100644 --- a/deploy/reverse-proxy.mdx +++ b/deploy/reverse-proxy.mdx @@ -4,6 +4,8 @@ description: "Configure a custom reverse proxy to serve your documentation." keywords: ["reverse proxy configuration","nginx","proxy routing","header forwarding"] --- + + Reverse proxy configurations are only supported for [Enterprise plans](https://mintlify.com/pricing?ref=reverse-proxy). @@ -12,11 +14,11 @@ To serve your documentation through a custom reverse proxy, you must configure r When you implement a reverse proxy, monitor for potential issues with domain verification, SSL certificate provisioning, authentication flows, performance, and analytics tracking. -## Choose your deployment approach +## Choose your deployment approach Mintlify supports two reverse proxy configurations depending on your subpath requirements. -- **Host at `/docs`**: Use `mintlify.dev` as the proxy target. Enable the **Host at `/docs`** toggle on the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. This is a simpler configuration with fewer routes. +- **Host at `/docs`**: Use `mintlify.dev` as the proxy target. Enable the **Host at `/docs`** toggle on the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. This is a simpler configuration with fewer routes. - **Custom subpath**: Use `mintlify.app` as the proxy target. This approach supports any subpath and requires additional routing rules. ## Host at `/docs` subpath @@ -25,7 +27,7 @@ Use this configuration when you want to serve documentation at the `/docs` path Before configuring your reverse proxy: -1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. +1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. 2. Enable the **Host at `/docs`** toggle. 3. Enter your domain and select **Add domain**. diff --git a/deploy/route53-cloudfront.mdx b/deploy/route53-cloudfront.mdx index d31c73c3c..4b3e8a2da 100644 --- a/deploy/route53-cloudfront.mdx +++ b/deploy/route53-cloudfront.mdx @@ -2,9 +2,11 @@ title: "AWS Route 53 and CloudFront" sidebarTitle: "AWS" description: "Deploy documentation at a subpath on AWS with Route 53 DNS and CloudFront CDN." -keywords: ["AWS deployment", "Route 53 DNS", "CloudFront CDN", "cache policies"] +keywords: ["AWS deployment", "Route 53 DNS", "CloudFront CDN", "cache policies"] --- + + import Propagating from "/snippets/custom-subpath-propagating.mdx"; To host your documentation at a subpath such as `yoursite.com/docs` using AWS Route 53 and CloudFront, you must configure your DNS provider to point to your CloudFront distribution. diff --git a/deploy/vercel-external-proxies.mdx b/deploy/vercel-external-proxies.mdx index d287ad415..4e4dae8de 100644 --- a/deploy/vercel-external-proxies.mdx +++ b/deploy/vercel-external-proxies.mdx @@ -1,10 +1,12 @@ --- title: "External proxies with Vercel" -description: "Configure external proxies in front of your Vercel deployment." +description: "Configure external proxies in front of your Vercel deployment." keywords: ["Vercel", "external proxy", "CloudFront", "domain verification", "SSL certificates"] --- -If you have an external proxy like Cloudflare or AWS CloudFront in front of your Vercel deployment, you must configure it properly to avoid conflicts with Vercel's domain verification and SSL certificate provisioning. + + +If you have an external proxy like Cloudflare or AWS CloudFront in front of your Vercel deployment, you must configure it properly to avoid conflicts with Vercel's domain verification and SSL certificate provisioning. Improper proxy configuration can prevent Vercel from provisioning Let's Encrypt SSL certificates and cause domain verification failures. @@ -18,7 +20,7 @@ Your external proxy must allow traffic to these specific paths without blocking, - `/.well-known/vercel/*` - Required for Vercel domain verification - `/mintlify-assets/_next/static/*` - Required for static assets -These paths should pass through directly to your Vercel deployment without modification. +These paths should pass through directly to your Vercel deployment without modification. ## Header forwarding requirements diff --git a/deploy/vercel.mdx b/deploy/vercel.mdx index 18e049d4b..442633a25 100644 --- a/deploy/vercel.mdx +++ b/deploy/vercel.mdx @@ -1,16 +1,18 @@ --- title: "Vercel" description: "Deploy documentation to a subpath on Vercel." -keywords: ["vercel.json", "Vercel deployment", "rewrites configuration", "subpath routing"] +keywords: ["vercel.json", "Vercel deployment", "rewrites configuration", "subpath routing"] --- + + import { VercelJsonGenerator } from "/snippets/vercel-json-generator.mdx"; Configure your `vercel.json` file to proxy requests from your main domain to your documentation at a subpath. ## vercel.json file -The `vercel.json` file configures how your project builds and deploys. It sits in your project's root directory and controls various aspects of your deployment, including routing, redirects, headers, and build settings. +The `vercel.json` file configures how your project builds and deploys. It sits in your project's root directory and controls various aspects of your deployment, including routing, redirects, headers, and build settings. We use the `rewrites` configuration in your `vercel.json` file to proxy requests from your main domain to your documentation. @@ -20,7 +22,7 @@ Rewrites map incoming requests to different destinations without changing the UR ### Host at `/docs` subpath -1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. +1. Navigate to [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard. 2. Click the **Host at `/docs`** toggle to the on position. Screenshot of the Custom domain setup page. The Host at `/docs` toggle is on and highlighted by an orange rectangle. diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index eafeee267..ba12cd359 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -5,6 +5,8 @@ description: "Work together on documentation with branches, pull requests, previ keywords: ["editor", "collaboration", "branches", "pull requests", "preview deployments", "share links"] --- + + Collaborate with your team on documentation using branch-based workflows, pull requests, and preview deployments. If you aren't familiar with Git, see [Git concepts](/guides/git-concepts). @@ -45,7 +47,7 @@ Preview deployments create temporary URLs where you can see your rendered change ### Access preview deployments 1. Click **Share** in the editor tool bar. -2. Click **Preview** to open the preview deployment in a new tab. +2. Click **Preview** to open the preview deployment in a new tab. 3. The preview URL shows your documentation with all saved changes applied. @@ -55,7 +57,7 @@ Preview deployments create temporary URLs where you can see your rendered change ### Share previews -Share the preview deployment URL with team members to gather feedback. Previews update automatically when you save additional changes. +Share the preview deployment URL with team members to gather feedback. Previews update automatically when you save additional changes. ### Preview authentication diff --git a/editor/index.mdx b/editor/index.mdx index 251c69058..edf3ead88 100644 --- a/editor/index.mdx +++ b/editor/index.mdx @@ -5,6 +5,8 @@ description: "Edit and publish documentation in your browser." keywords: ["editor", "visual", "gitbook"] --- + + deployment. - **Shareable preview links**: Create preview links for your team from the editor. - **Drag-and-drop navigation**: Organize your site structure visually without editing configuration files. - **Built-in media manager**: Upload and organize images, videos, and other assets. diff --git a/editor/live-preview.mdx b/editor/live-preview.mdx index 0b43a189f..a47da0508 100644 --- a/editor/live-preview.mdx +++ b/editor/live-preview.mdx @@ -4,6 +4,8 @@ description: "Preview your documentation site and see changes in real time as yo keywords: ["preview"] --- + + Preview your documentation site as you edit. Live preview shows your pages exactly as they appear when published, updating in real time as you make changes to content, navigation, and configuration. ## Open live preview @@ -29,7 +31,7 @@ Click the button in the toolbar to open a live preview in a ## Live preview versus preview deployments -| | Live preview | Preview deployment | +| | Live preview | Preview deployment | |---------|--------------|-------------------| | **Speed** | Instant | Requires build time | | **Access** | Local URL | Shareable URL | diff --git a/editor/publish.mdx b/editor/publish.mdx index 5e8c17d11..d6b20e751 100644 --- a/editor/publish.mdx +++ b/editor/publish.mdx @@ -5,18 +5,20 @@ description: "Save your work and publish changes to your documentation site." keywords: ["editor", "publish", "changes", "branches", "pull requests"] --- + + ## Publishing workflows The editor supports two workflows for publishing documentation updates. The workflow you use depends on your repository's branch protection rules and the branch you work on. -* **Create pull requests**: If your repository has a branch protection rule that requires pull requests before changes can merge into your deployment branch, the editor creates a pull request when you publish changes. -* **Publish directly**: If your repository has no branch protection rules, your changes merge to the deployment branch and deploy immediately when you publish. +* **Create pull requests**: If your repository has a branch protection rule that requires pull requests before changes can merge into your deployment branch, the editor creates a pull request when you publish changes. +* **Publish directly**: If your repository has no branch protection rules, your changes merge to the deployment branch and deploy immediately when you publish. | Branch type | Branch protection | Publishing workflow | |-------------|-------------------|------------------------------| | Deployment branch | None | Commits and deploys changes | | Deployment branch | Pull requests required | Creates a pull request | -| Feature branch | None | Merges changes to deployment branch and deploys changes | +| Feature branch | None | Merges changes to deployment branch and deploys changes | | Feature branch | Pull requests required | Creates a pull request | @@ -33,9 +35,9 @@ As you edit, the editor tracks your changes. - Media uploads and organization. - Configuration updates. -When you work on your deployment branch, your changes save automatically. +When you work on your deployment branch, your changes save automatically. - + Web editor toolbar showing one pending change. Web editor toolbar showing one pending change. @@ -57,7 +59,7 @@ The **Publish** button is disabled when there are no pending changes or when a p ## Resolve conflicts -Conflicts occur when your branch and the deployment branch have incompatible changes to the same files. +Conflicts occur when your branch and the deployment branch have incompatible changes to the same files. ### What causes conflicts diff --git a/guides/branches.mdx b/guides/branches.mdx index 7b1b23aa7..7aa566964 100644 --- a/guides/branches.mdx +++ b/guides/branches.mdx @@ -1,10 +1,12 @@ --- title: "Work with branches" description: "Create branches to preview changes and collaborate before publishing." -keywords: ["Git","branches","branch workflow","creating branches","deployment branch"] +keywords: ["Git","branches","branch workflow","creating branches","deployment branch"] --- -Branches are a feature of version control that point to specific commits in your repository. Your deployment branch, usually called `main`, represents the content used to build your live documentation site. All other branches are independent of your live docs unless you choose to merge them into your deployment branch. + + +Branches are a feature of version control that point to specific commits in your repository. Your deployment branch, usually called `main`, represents the content used to build your live documentation site. All other branches are independent of your live docs unless you choose to merge them into your deployment branch. Branches let you create separate instances of your documentation to make changes, get reviews, and try new approaches before publishing. Your team can work on branches to update different parts of your documentation simultaneously without affecting what users see on your live site. @@ -120,4 +122,4 @@ Use clear, descriptive names that explain the purpose of a branch. ## Merge branches -Once your changes are ready to publish, create a pull request to merge your branch into the deployment branch. \ No newline at end of file +Once your changes are ready to publish, create a pull request to merge your branch into the deployment branch. diff --git a/guides/git-concepts.mdx b/guides/git-concepts.mdx index 8f1794cce..da9cfb2e0 100644 --- a/guides/git-concepts.mdx +++ b/guides/git-concepts.mdx @@ -4,6 +4,8 @@ description: "Learn version control and collaboration fundamentals for docs-as-c keywords: ["Git","version control","collaboration","commits","pull requests","merge requests"] --- + + Git is a version control system that tracks changes to your documentation and enables team collaboration. With Git, you can see what changed over time in files, who made the changes, when they made changes, and why. Git also makes it easy to revert to previous versions of files if you need to undo changes. The web editor performs Git operations behind the scenes. With an understanding of Git, you can work more effectively with the web editor and collaborate with team members who use local development. @@ -53,7 +55,7 @@ If you're completely new to Git and version control, here's a path to get starte - A branch points to a specific commit in your repository. Your live documentation builds from a deployment branch. You can have any number of other branches with changes that are not yet published to your live documentation. If you want to incorporate the changes from a branch into your live documentation, you can merge the branch into your deployment branch through a pull request. + A branch points to a specific commit in your repository. Your live documentation builds from a deployment branch. You can have any number of other branches with changes that are not yet published to your live documentation. If you want to incorporate the changes from a branch into your live documentation, you can merge the branch into your deployment branch through a pull request. Use branches to work on changes without affecting your live documentation, safely experiment with new features, and get reviews before publishing. @@ -71,13 +73,13 @@ If you're completely new to Git and version control, here's a path to get starte Occurs when two people change the same part of a file differently. Git asks you to manually choose which change to keep or combine both changes. - The primary branch of your project. Changes to this branch automatically publish to your documentation site. Often called `main`, but you can set any branch as your deployment branch. + The primary branch of your project. Changes to this branch automatically publish to your documentation site. Often called `main`, but you can set any branch as your deployment branch. A diff (or difference) shows the changes between two versions of a file. When reviewing pull requests, diffs highlight what is different from the original version of the file. - Combine changes from one branch into another. Usually done via pull request after review to incorporate feature work into your deployment branch. + Combine changes from one branch into another. Usually done via pull request after review to incorporate feature work into your deployment branch. Get the latest changes from the remote repository to your local copy. Keeps you up to date with other people's work. @@ -121,12 +123,12 @@ When you: - **Make changes**: The editor tracks your changes as a draft that can become a commit when you're ready to save your work. - **Save changes**: The editor makes a commit with your changes, preserving your work in the project history. - **Create a branch**: The editor creates a new branch in your repository that anyone with access to the repository can use to collaborate and review changes. -- **Publish on your deployment branch**: The editor commits and pushes directly to your deployment branch, which publishes your changes immediately. -- **Publish on other branches**: The editor creates a pull request, which allows you to get feedback from others before merging your changes into your deployment branch. +- **Publish on your deployment branch**: The editor commits and pushes directly to your deployment branch, which publishes your changes immediately. +- **Publish on other branches**: The editor creates a pull request, which allows you to get feedback from others before merging your changes into your deployment branch. ## Common workflows -### Publish directly to your deployment branch +### Publish directly to your deployment branch @@ -150,7 +152,7 @@ When you: - To create pull requests from the web editor, you must have a branch protection rule enabled that requires pull requests before changes can merge into your deployment branch. Without branch protection rules, changes on branches merge to your deployment branch when published. + To create pull requests from the web editor, you must have a branch protection rule enabled that requires pull requests before changes can merge into your deployment branch. Without branch protection rules, changes on branches merge to your deployment branch when published. 1. Create branch from the branch dropdown in the editor toolbar. 2. Make and save changes on the branch. @@ -170,13 +172,13 @@ When you: - Work on changes in a branch separate from your deployment branch so that you can share and review the changes before publishing. + Work on changes in a branch separate from your deployment branch so that you can share and review the changes before publishing. Edit files and commit changes to the feature branch. - Create a pull request to propose merging the changes on your feature branch into the deployment branch. + Create a pull request to propose merging the changes on your feature branch into the deployment branch. Check your changes. The pull request shows line-by-line differences from the original version of the file. @@ -198,4 +200,4 @@ Every team develops their own workflows and preferences, but these are some gene - **Keep branches focused**: Keep the changes on a branch focused on a specific task or project. This makes reviews easier and reduces conflicts. - **Delete branches after merging**: Delete branches when you no longer need them to keep your repository tidy. - **Pull before you push**: Always pull the latest changes before pushing to avoid conflicts. The web editor does this automatically. -- **Review your own changes first**: Check the diff before creating a pull request. \ No newline at end of file +- **Review your own changes first**: Check the diff before creating a pull request. diff --git a/guides/internationalization.mdx b/guides/internationalization.mdx index 149636516..efc3ae23a 100644 --- a/guides/internationalization.mdx +++ b/guides/internationalization.mdx @@ -4,6 +4,8 @@ description: "Set up multi-language documentation to reach global audiences." keywords: ["internationalization", "i18n", "multi-language", "translations", "localization", "language switcher"] --- + + Internationalization (i18n) is the process of designing software or content to work for different languages and locales. This guide explains how to structure files, configure navigation, and maintain translations effectively so that you can help users access your documentation in their preferred language and improve global reach. ## File structure @@ -277,4 +279,4 @@ Some languages require more or less space than English. Test your translated con ### Character encoding -Ensure your development environment and deployment pipeline support UTF-8 encoding to properly display all characters in languages with different alphabets and special characters. +Ensure your development environment and deployment pipeline support UTF-8 encoding to properly display all characters in languages with different alphabets and special characters. diff --git a/guides/knowledge-base.mdx b/guides/knowledge-base.mdx index e3ff3df5c..ff9c7db35 100644 --- a/guides/knowledge-base.mdx +++ b/guides/knowledge-base.mdx @@ -5,6 +5,8 @@ description: "Host your internal knowledge base on Mintlify to consolidate infor keywords: ["knowledge base", "internal documentation", "private docs", "kb", "knowledge management", "knowledge capture"] --- + + An internal knowledge base helps your team find answers and maintain a source of truth. If your team has information spread across different channels and platforms, people might find inaccurate or no information when they search for answers. A centralized knowledge base solves this by putting answers where everyone can find them and giving your team a specific place to record shared knowledge. Mintlify provides the infrastructure for knowledge bases that your entire team can contribute to. @@ -82,7 +84,7 @@ Your `docs.json` file defines the navigation structure of your knowledge base. C "pages": [ "engineering/overview", "engineering/dev-setup", - "engineering/deployment", + "engineering/deployment", "engineering/code-standards" ] } @@ -125,7 +127,7 @@ Move your exported content into a folder structure that matches the navigation s └── engineering/ ├── overview.mdx ├── dev-setup.mdx - ├── deployment.mdx + ├── deployment.mdx └── code-standards.mdx ``` diff --git a/installation.mdx b/installation.mdx index 32fa39b46..66e74b8a0 100644 --- a/installation.mdx +++ b/installation.mdx @@ -4,6 +4,8 @@ description: "Use the CLI to preview docs locally, test changes in real-time, an keywords: ["CLI", "npm", "local development", "Node.js", "pnpm", "mint dev", "broken links", "accessibility"] --- + + - 1. Go to the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. + 1. Go to the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. 2. Note your repository location. It is one of these formats: - `mintlify-community/docs-{org-name}-{id}` (Mintlify-hosted repository) - `your-org/your-repo` (your own GitHub repository) @@ -38,7 +40,7 @@ The CLI also has utilities for maintaining your documentation, including command - Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings). + Replace `your-org/your-repo` with your actual repository details from [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings). ```bash git clone https://github.com/your-org/your-repo @@ -53,7 +55,7 @@ The CLI also has utilities for maintaining your documentation, including command You can clone your repository as a private or public repository. Public repositories are visible to anyone who navigates to the repository URL. Private repositories are only visible to people in your organization. - On the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard, select **Clone as private** or **Clone as public**. + On the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard, select **Clone as private** or **Clone as public**. diff --git a/optimize/pdf-exports.mdx b/optimize/pdf-exports.mdx index a8e2b14ea..ec77e1b68 100644 --- a/optimize/pdf-exports.mdx +++ b/optimize/pdf-exports.mdx @@ -4,6 +4,8 @@ description: "Export your documentation as a single PDF file." keywords: ["PDF", "offline docs"] --- + + export const DownloadPDFButton = () => { return ( @@ -21,7 +23,7 @@ You can export your docs as a single PDF file for offline viewing. The PDF will ## Exporting a PDF -1. Navigate to the [General](https://dashboard.mintlify.com/settings/deployment/general) page in the Project Settings section of your dashboard. +1. Navigate to the [General](https://dashboard.mintlify.com/settings/deployment/general) page in the Project Settings section of your dashboard. 2. Select the **Export all content** button. 3. Optionally, customize the export options: - **Page format**: Choose the page size of the PDF. diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 76f6e5c3a..5b356588c 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -4,6 +4,8 @@ description: "Design information architecture that aligns with user needs." keywords: ["navigation structure", "sidebar configuration", "page organization", "navigation groups"] --- + + The [navigation](/organize/settings#param-navigation) property in `docs.json` controls the structure and information hierarchy of your documentation. With proper navigation configuration, you can organize your content so that users can find exactly what they're looking for. @@ -709,7 +711,7 @@ Each navigation element can contain one type of child element at each level of y { "item": "Guides", "icon": "book", - "pages": ["platform/guides/deployment", "platform/guides/scaling"] + "pages": ["platform/guides/deployment", "platform/guides/scaling"] } ] }, diff --git a/quickstart.mdx b/quickstart.mdx index 87b02debf..a28d536ba 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,6 +4,8 @@ description: "Deploy your documentation site and make your first change." keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"] --- + + After you complete this guide, you'll have a live documentation site ready to customize and update. ## Before you begin @@ -104,7 +106,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa View your preview at `http://localhost:3000`. - Commit and push your changes to trigger a deployment: + Commit and push your changes to trigger a deployment: ```bash git add . @@ -112,7 +114,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa git push ``` - Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. + Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. @@ -142,7 +144,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa Click the **Publish** button in the top-right of the web editor toolbar. - On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. + On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. @@ -160,4 +162,4 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa Use your own domain for your documentation site. - \ No newline at end of file + diff --git a/skill.md b/skill.md index 7b2d58ccf..50b25248c 100644 --- a/skill.md +++ b/skill.md @@ -8,6 +8,8 @@ metadata: version: "1.0" --- + + # Mintlify best practices **Always consult [mintlify.com/docs](https://mintlify.com/docs) for components, configuration, and latest features.** @@ -248,7 +250,7 @@ Mintlify deploys automatically when changes are pushed to the connected Git repo **Requires dashboard setup (human task):** - Custom domains and subdomains -- Preview deployment settings +- Preview deployment settings - DNS configuration For `/docs` subpath hosting with Vercel or Cloudflare, agents can help configure rewrite rules. See [/docs subpath](https://mintlify.com/docs/deploy/vercel). diff --git a/snippets/components/rainbow-text.mdx b/snippets/components/rainbow-text.mdx new file mode 100644 index 000000000..80fdf8ea5 --- /dev/null +++ b/snippets/components/rainbow-text.mdx @@ -0,0 +1,13 @@ +export const RainbowText = ({ children }) => ( + + {children} + +); diff --git a/status.mdx b/status.mdx index 8759f29fa..9bac71d6f 100644 --- a/status.mdx +++ b/status.mdx @@ -3,6 +3,8 @@ title: "Status page" description: "Check Mintlify service status and subscribe to incident updates." --- + + Mintlify maintains a public status page where you can check the real-time operational status of its services and view historical uptime data. ## Accessing the status page @@ -12,7 +14,7 @@ Visit [status.mintlify.com](https://status.mintlify.com) to view the current sta The status page displays the operational status of: - **Documentation** - Hosted documentation sites -- **Updates** - Documentation update and deployment services +- **Updates** - Documentation update and deployment services - **Dashboard** - The Mintlify dashboard and management interface ## Subscribing to updates