From b1091ecb7d80512e5914687c4f3f6ed51995912a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:14 +0000 Subject: [PATCH 01/17] Update quickstart.mdx --- quickstart.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index cf1ccb279..b700db45f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -3,9 +3,7 @@ title: "Quickstart" description: "Deploy your documentation in minutes" --- -This quickstart guide shows you how to set up and deploy your documentation site in minutes. - -After completing this guide, you will have a live documentation site ready to customize and expand. +Set up and deploy your documentation site in minutes. From ee5a6cc99c22933caf6405de62bdde02f7aaf92b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:19 +0000 Subject: [PATCH 02/17] Update quickstart.mdx --- quickstart.mdx | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index b700db45f..ce5704cbd 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -13,13 +13,7 @@ Set up and deploy your documentation site in minutes. ## Getting started -After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: - -``` -https://.mintlify.app -``` - -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). +After onboarding, your site deploys to `https://.mintlify.app`. Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). Mintlify Domain From 3b0b1e8fe126ce20911ea56ad77ae3dad778ada6 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:24 +0000 Subject: [PATCH 03/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index ce5704cbd..adac1e14f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -20,7 +20,7 @@ After onboarding, your site deploys to `https://.mintlify.app Mintlify Domain -Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site. +Use this URL for testing and sharing with your team. ### Install the GitHub App From 461bad2fe979bc991fa6ecf33bef715e9cc91e00 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:29 +0000 Subject: [PATCH 04/17] Update quickstart.mdx --- quickstart.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index adac1e14f..39ef242fe 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -24,9 +24,7 @@ Use this URL for testing and sharing with your team. ### Install the GitHub App -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. - -Install the GitHub App by following the instructions from the onboarding checklist or your dashboard. +Install the GitHub App to automate deployment when you push changes. 1. Navigate to **Settings** in your Mintlify dashboard. 2. Select **GitHub App** from the sidebar. From c49c565b385ad14ded0ff1bdcdc9d5b939751194 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:33 +0000 Subject: [PATCH 05/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 39ef242fe..3700f7fbc 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -53,7 +53,7 @@ Install the GitHub App to automate deployment when you push changes. ## Editing workflows -Mintlify offers two workflows for creating and maintaining your documentation: +Choose your preferred workflow: For users who prefer working with existing tools in their local environment. Click to jump to this section. From 91aeb8ec24630fb8d1c83ad977e347b5a40fccd1 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:38 +0000 Subject: [PATCH 06/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 3700f7fbc..fa8a21d6e 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -65,7 +65,7 @@ Choose your preferred workflow: ## Code-based workflow -The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code. +Work locally with your existing development tools and Git workflow. ### Install the CLI From 450ce20b6a7829d11a8a539a6349b4639a49aa93 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:43 +0000 Subject: [PATCH 07/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index fa8a21d6e..11aff62d4 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -73,7 +73,7 @@ Work locally with your existing development tools and Git workflow. **Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher. -To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal: +Install the [mint](https://www.npmjs.com/package/mint) CLI: ```bash npm From bbababb958ddcb498432408a8f1b3fe1a54067ee Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:48 +0000 Subject: [PATCH 08/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 11aff62d4..e65683c3f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -87,7 +87,7 @@ Install the [mint](https://www.npmjs.com/package/mint) CLI: ### Edit the documentation -After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page: +Edit your documentation files. For example, update the introduction page title: 1. Open your repository created during onboarding. 2. Open `index.mdx` and locate the top of the file: From 17f058701fba873229a6d529ad0718e22923638e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:53 +0000 Subject: [PATCH 09/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index e65683c3f..b9a1bfb63 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -110,7 +110,7 @@ description: "This is the introduction to the documentation" ### Preview the changes -To preview the changes locally, run the following command: +Preview changes locally: ```bash mint dev From 4430b190303d2eba495753b4fae489f9e7f66529 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 19:59:58 +0000 Subject: [PATCH 10/17] Update quickstart.mdx --- quickstart.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index b9a1bfb63..f963bb384 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -125,11 +125,7 @@ Your preview will be available at `localhost:3000`. ### Push the changes -When you are ready to publish your changes, push them to your repository. - -Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com). - -After the deployment completes, your latest update will be available at `.mintlify.app`. +Push changes to your repository. Mintlify automatically builds and deploys updates. Monitor deployment status in your GitHub commit history or the [dashboard](https://dashboard.mintlify.com). Optionally, skip the web editor workflow and jump to adding a custom domain. From 717ddd55800dcc209d20da1b960430bacb89c944 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:00:04 +0000 Subject: [PATCH 11/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index f963bb384..2f424c722 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -133,7 +133,7 @@ Push changes to your repository. Mintlify automatically builds and deploys updat ## Web editor workflow -The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools. +Edit documentation in your browser with a visual interface. ### Access the web editor From b97604dbe30f7e76853ca589ead1ef55f8636b76 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:00:14 +0000 Subject: [PATCH 12/17] Update quickstart.mdx --- quickstart.mdx | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 2f424c722..a8024067d 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -151,11 +151,7 @@ Edit documentation in your browser with a visual interface. ### Edit the documentation -In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page: - -Find and select `index.mdx` in the file explorer. - -Then, in the editor, update the title field to "Hello World". +Navigate to `index.mdx` in the file explorer and update the title field to "Hello World". Editing in Web Editor From fb26b96ef7657613e76ed54397b4a866590b2b34 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:00:19 +0000 Subject: [PATCH 13/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index a8024067d..2445c13be 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -164,7 +164,7 @@ Navigate to `index.mdx` in the file explorer and update the title field to "Hell ### Publish your changes -When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site. +Select **Publish** in the top-right corner to deploy your changes. Use branches to preview and review changes through pull requests before deploying to your live site. From 2c4430ae041ded4fd734061cbb4060c165be67f4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:00:24 +0000 Subject: [PATCH 14/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 2445c13be..830f454cb 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -170,7 +170,7 @@ Select **Publish** in the top-right corner to deploy your changes. Use branches to preview and review changes through pull requests before deploying to your live site. -For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor). +See the [web editor documentation](/editor) for details on branches and pull requests. ## Adding a custom domain From 2d5d67facb62cc8d6f05d924ac04e5f469d2d8e5 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:00:30 +0000 Subject: [PATCH 15/17] Update quickstart.mdx --- quickstart.mdx | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 830f454cb..e8d884833 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -174,9 +174,7 @@ See the [web editor documentation](/editor) for details on branches and pull req ## Adding a custom domain -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. - -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +Add a custom domain for production. Navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. Custom Domain From a194a6ebeb4d92444db0d63cf873e4c0f66c18fa Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:00:36 +0000 Subject: [PATCH 16/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index e8d884833..840d26de3 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -195,7 +195,7 @@ Enter your domain (for example, `docs.yourcompany.com`) and follow the provided ## Next steps -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: +Your documentation site is live. Here are suggested next steps: Configure site-wide styling, navigation, integrations, and more with the `docs.json` file. From 811ad03932f3a0ccc64d5ec29280897661dbb28c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 30 Oct 2025 20:00:40 +0000 Subject: [PATCH 17/17] Update quickstart.mdx --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 840d26de3..1d5bd5376 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -215,7 +215,7 @@ Your documentation site is live. Here are suggested next steps: ## Troubleshooting -If you encounter issues during the setup process, check these common troubleshooting solutions: +Common troubleshooting solutions: