From cf6792a8a618090b3247219396072ccefc3d872f Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:49:46 +0000
Subject: [PATCH 1/8] Update quickstart.mdx
---
quickstart.mdx | 26 +++++++++++++++++++-------
1 file changed, 19 insertions(+), 7 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 076b50534..f1528fc7d 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -1,17 +1,29 @@
---
title: "Quickstart"
-description: "Deploy your documentation in minutes"
-icon: "rocket"
+description: "From zero to deployed docs in under 5 minutes"
+icon: "zap"
---
-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.
+
+ Transform your ideas into beautiful, interactive documentation in minutes, not hours.
+
-
+## What you'll accomplish
-**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.
+
+
+ Your docs will be instantly available at a custom URL
+
+
+ Pick between code-first or visual editing
+
+
+ Add your custom domain and branding
+
+
+
+**Before you start**: [Create your account](https://mintlify.com/start) and complete the quick onboarding flow.
## Getting started
From 6131e30ecd1c5da1a80716801e46f66ff893a2b3 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:49:55 +0000
Subject: [PATCH 2/8] Update quickstart.mdx
---
quickstart.mdx | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index f1528fc7d..dee9ab18d 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -26,22 +26,24 @@ icon: "zap"
**Before you start**: [Create your account](https://mintlify.com/start) and complete the quick onboarding flow.
-## Getting started
+## π― Step 1: Your site is live!
-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/).
+
+ Your documentation site is automatically deployed during onboarding to:
+
+ ```
+ https://.mintlify.app
+ ```
+
-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.
+
+**Pro tip**: Bookmark your dashboard URL! You'll find your site link on the Overview page of your [dashboard](https://dashboard.mintlify.com/).
+
### Install the GitHub App
From 4c8f30c5b758ded174ec22b40b3c84cffaa1c74f Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:50:07 +0000
Subject: [PATCH 3/8] Update quickstart.mdx
---
quickstart.mdx | 70 ++++++++++++++++++++++++++++----------------------
1 file changed, 40 insertions(+), 30 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index dee9ab18d..84ae6937c 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -45,36 +45,46 @@ icon: "zap"
**Pro tip**: Bookmark your dashboard URL! You'll find your site link on the Overview page of your [dashboard](https://dashboard.mintlify.com/).
-### 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.
-
-1. Navigate to **Settings** in your Mintlify dashboard.
-2. Select **GitHub App** from the sidebar.
-3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page.
-4. Select the organization or user account where you want to install the app.
-5. Select the repositories that you want to connect.
-
-
- 
- 
-
-
-
- Update the GitHub App permissions if you move your documentation to a different repository.
-
-
-### Authorize your GitHub account
-
-1. Navigate to **Settings** in your Mintlify dashboard.
-2. Select **My Profile** from the sidebar.
-3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page.
-
-
- An admin for your GitHub organization may need to authorize your account depending on your organization settings.
-
+### π Connect GitHub for auto-deployment
+
+
+
+
+
+ Navigate to **Settings** β **GitHub App** in your dashboard
+
+
+ Click **Install GitHub App** to open the installation page
+
+
+ Select your organization and the repositories to connect
+
+
+
+
+
+
+
+
+
+
+
+
+ Navigate to **Settings** β **My Profile**
+
+
+ Click **Authorize GitHub account**
+
+
+ Follow the GitHub authorization flow
+
+
+
+
+ Your GitHub organization admin may need to approve the authorization.
+
+
+
## Editing workflows
From 35a2a8117d1a4e0ae0dfdd0511e6aaad60dc0ca3 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:50:16 +0000
Subject: [PATCH 4/8] Update quickstart.mdx
---
quickstart.mdx | 22 +++++++++++++---------
1 file changed, 13 insertions(+), 9 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 84ae6937c..b69bf752f 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -86,17 +86,21 @@ icon: "zap"
-## Editing workflows
+## π οΈ Step 2: Choose your editing workflow
-Mintlify offers two workflows for creating and maintaining your documentation:
-
-
- For users who prefer working with existing tools in their local environment. Click to jump to this section.
-
+
+
+ **Perfect for developers**
+
+ Work locally with your favorite editor, Git workflows, and CLI tools.
+
-
- For users who prefer a visual interface in their web browser. Click to jump to this section.
-
+
+ **Perfect for teams**
+
+ Edit directly in your browser with real-time preview and collaboration.
+
+
## Code-based workflow
From 700fd07a441efd13d650f58bce91f7e427d4083b Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:50:35 +0000
Subject: [PATCH 5/8] Update quickstart.mdx
---
quickstart.mdx | 102 ++++++++++++++++++++++++++++++-------------------
1 file changed, 62 insertions(+), 40 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index b69bf752f..f21fb8407 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -102,13 +102,13 @@ icon: "zap"
-## Code-based 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.
-
-### Install the CLI
+
+ Perfect for teams who want to manage docs alongside code with full Git integration.
+
-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 CLI
```bash npm
@@ -118,61 +118,83 @@ To work locally with your documentation, install the Command Line Interface (CLI
```bash pnpm
pnpm add -g mint
```
+
+ ```bash yarn
+ yarn global add mint
+ ```
-
- You need Node.js installed on your machine. If you encounter installation issues, check the troubleshooting guide.
-
-
-### Edit the documentation
-
-After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page:
-
-1. Open your repository created during onboarding.
-2. Open `index.mdx` and locate the top of the file:
+
+**Requirements**: Node.js v19+ is required. [Download here](https://nodejs.org/) if needed.
+
-```mdx index.mdx
----
-title: "Introduction"
-description: "This is the introduction to the documentation"
----
-```
+### βοΈ Make your first edit
-3. Update the `title` field to `"Hello World"`.
+Let's update your homepage to see the magic in action:
-```mdx index.mdx {2}
----
-title: "Hello World"
-description: "This is the introduction to the documentation"
----
-```
+
+
+ Navigate to the repository created during onboarding
+
+
+ Find the frontmatter at the top:
+ ```mdx index.mdx
+ ---
+ title: "Introduction"
+ description: "This is the introduction to the documentation"
+ ---
+ ```
+
+
+ Change it to something exciting:
+ ```mdx index.mdx {2}
+ ---
+ title: "Welcome to our docs! π"
+ description: "This is the introduction to the documentation"
+ ---
+ ```
+
+
-### Preview the changes
+### π Preview locally
-To preview the changes locally, run the following command:
+Start the development server:
```bash
mint dev
```
-Your preview will be available at `localhost:3000`.
+
+ Your docs are now live at `localhost:3000` with hot reload enabled.
+
-### 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).
+### π Deploy your changes
-After the deployment completes, your latest update will be available at `.mintlify.app`.
+
+
+ ```bash
+ git add .
+ git commit -m "Update homepage title"
+ ```
+
+
+ ```bash
+ git push origin main
+ ```
+
+
+ Mintlify automatically builds and deploys your changes!
+
+
-
- Optionally, skip the web editor workflow and jump to adding a custom domain.
-
+
+Monitor deployment status in your [dashboard](https://dashboard.mintlify.com) or GitHub Actions tab.
+
## Web editor workflow
From 80696b2eaff059a8ec5791c7b3a00cdbe750e46c Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:50:53 +0000
Subject: [PATCH 6/8] Update quickstart.mdx
---
quickstart.mdx | 72 ++++++++++++++++++++++++++++++--------------------
1 file changed, 43 insertions(+), 29 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index f21fb8407..06edff4ae 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -196,51 +196,65 @@ mint dev
Monitor deployment status in your [dashboard](https://dashboard.mintlify.com) or GitHub Actions tab.
-## Web editor workflow
+## β¨ 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.
-
-### Access the web editor
+
+ Perfect for content creators and teams who prefer visual editing with instant preview.
+
-1. Log in to your [dashboard](https://dashboard.mintlify.com).
-2. Select **Editor** on the left sidebar.
+### π Access the editor
-
- If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.
-
+
+
+ Log in to your [dashboard](https://dashboard.mintlify.com)
+
+
+ Click **Editor** in the left sidebar
+
+
+ Your visual editor is ready to go!
+
+
-### 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".
-
-
- 
- 
-
+### βοΈ Make your first edit
-
- The editor provides a rich set of formatting tools and components. Type / in the editor to open the command menu and access these tools.
-
+
+
+ 1. Find `index.mdx` in the file explorer
+ 2. Update the title to "Welcome to our docs! π"
+ 3. See your changes instantly in the preview
+
+
+
+
+
+
+
+
+
+ Type `/` anywhere to open the command menu and access:
+ - Interactive components
+ - Code blocks with syntax highlighting
+ - Tables, callouts, and more
+
+
+
-### Publish your changes
+### π Publish instantly
-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.
+
+ Click the **Publish** button in the top-right corner and your changes go live immediately!
+
- Use branches to preview and review changes through pull requests before deploying to your live site.
+**Pro workflow**: Use branches to preview changes and collaborate with pull requests before going live. Learn more in our [web editor guide](/editor/getting-started).
-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/getting-started).
-
## 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.
From 4e4d0952d5f7e438d2dccedfcc9bee7c64381e8e Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:51:07 +0000
Subject: [PATCH 7/8] Update quickstart.mdx
---
quickstart.mdx | 43 +++++++++++++++++++++++++++++--------------
1 file changed, 29 insertions(+), 14 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 06edff4ae..1519800ee 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -255,28 +255,43 @@ Monitor deployment status in your [dashboard](https://dashboard.mintlify.com) or
**Pro workflow**: Use branches to preview changes and collaborate with pull requests before going live. Learn more in our [web editor guide](/editor/getting-started).
-## Adding a custom domain
+## π Step 3: Add your custom domain
-While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.
+
+ Transform `your-project.mintlify.app` into `docs.yourcompany.com` for a professional touch.
+
-To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
+### Quick setup
+
+
+
+ Navigate to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard
+
+
+ Add your desired domain (e.g., `docs.yourcompany.com`)
+
+
+ Add this CNAME record with your domain provider:
+
+
+ | Record Type | Name | Value | TTL |
+ |-------------|------|-------|-----|
+ | CNAME | docs | cname.mintlify.app | 3600 |
+
+
+
+ DNS changes typically take 5-30 minutes (up to 48 hours max)
+
+
-Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider.
-
-
-| Record Type | Name | Value | TTL |
-|-------------|------|-------|-----|
-| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |
-
-
-
- DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
-
+
+**Check DNS status**: Use [DNSChecker](https://dnschecker.org) to verify your CNAME record is propagating correctly.
+
## Next steps
From 9a93f079df8f609e9e59a9b92bea04e51087bb65 Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Mon, 29 Sep 2025 17:51:24 +0000
Subject: [PATCH 8/8] Update quickstart.mdx
---
quickstart.mdx | 60 ++++++++++++++++++++++++++++++++++++--------------
1 file changed, 43 insertions(+), 17 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 1519800ee..0d223fb72 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -293,26 +293,52 @@ Monitor deployment status in your [dashboard](https://dashboard.mintlify.com) or
**Check DNS status**: Use [DNSChecker](https://dnschecker.org) to verify your CNAME record is propagating correctly.
-## Next steps
+## π You're all set!
-Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:
-
-
- Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
-
-
- Learn how to customize colors, fonts, and the overall appearance of your documentation site.
-
-
- Structure your documentation with intuitive navigation to help users find what they need.
-
-
- Enhance your documentation with interactive components like accordions, tabs, and code samples.
-
-
- Create interactive API references with OpenAPI and AsyncAPI specifications.
+
+ Your documentation site is live and ready to impress. Time to make it uniquely yours!
+### What's next?
+
+
+
+ **Customize themes**
+
+ Colors, fonts, and branding to match your company
+
+
+
+ **Structure navigation**
+
+ Create intuitive paths for your users
+
+
+
+ **Global configuration**
+
+ SEO, integrations, and site-wide options
+
+
+
+ **Interactive elements**
+
+ Tabs, accordions, code blocks, and more
+
+
+
+ **OpenAPI integration**
+
+ Auto-generate interactive API references
+
+
+
+ **Analytics dashboard**
+
+ Monitor usage and improve your docs
+
+
+
## Troubleshooting
If you encounter issues during the setup process, check these common troubleshooting solutions: