From 112956ec196ee0dd8c2f6c7baa9a31003f7d5e63 Mon Sep 17 00:00:00 2001
From: "mintlify-development[bot]"
<109878554+mintlify-development[bot]@users.noreply.github.com>
Date: Wed, 28 Jan 2026 00:50:35 +0000
Subject: [PATCH] Simplify quickstart page for better user experience
- Removed complex 'Before you begin' section
- Streamlined deployment to 4 clear steps
- Condensed 'Make your first change' from detailed instructions to essential actions
- Made web editor the recommended path for new users
- Removed optional accordion that added complexity
- Focus on getting users to success quickly rather than explaining concepts upfront
---
quickstart.mdx | 124 +++++++++++++------------------------------------
1 file changed, 31 insertions(+), 93 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index 7bfe62594..4b4fbe3c6 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -4,80 +4,33 @@ description: "Deploy your documentation site and make your first change."
keywords: ["quickstart","deploy","get started","first steps"]
---
-After you complete this guide, you'll have a live documentation site ready to customize and update.
+Get your documentation site live in minutes. After completing this guide, you'll have a deployed site ready to customize.
-## Before you begin
+## Deploy your site
-Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation repository.
+1. Go to [mintlify.com/start](https://mintlify.com/start)
+2. Connect your GitHub account
+3. Create or select a repository for your documentation
+4. Complete the onboarding process
-When you connect your documentation repository to your Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
-
-## Deploy your documentation site
-
-Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.
-
-After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.
-
-
-
- If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you.
-
- This lets you use the web editor immediately and migrate to your own repository later.
-
-
-
-## View your deployed site
-
-Your documentation site is now deployed at `https://.mintlify.app`.
-
-Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
-
-
- 
-
- 
-
+Your documentation site is now live at `https://.mintlify.app`.
- Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain).
+ Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
## Make your first change
+Choose your preferred editing method:
+
-
+
-
- The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.
-
-
-
- ```bash npm
- npm i -g mint
- ```
-
-
- ```bash pnpm
- pnpm add -g mint
- ```
-
-
-
- See [Install the CLI](/installation) for full details and troubleshooting.
-
-
- If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository).
+
+ Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
-
- Open `index.mdx` in your preferred editor and update the description in the frontmatter:
+
+ Open `index.mdx` and update the description:
```mdx
---
@@ -86,48 +39,33 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
---
```
-
- Run the following command from your documentation directory:
+
+ Click **Publish** in the top-right corner to deploy your changes.
+
+
+
+
+
+
+ ```bash
+ npm i -g mint
+ ```
+
+
+ Clone your repository, edit `index.mdx`, then preview locally:
```bash
mint dev
```
-
- View your preview at `http://localhost:3000`.
-
- Commit and push your changes to trigger a deployment:
+
+ Push your changes to automatically deploy:
```bash
git add .
git commit -m "Update description"
git push
```
-
- Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
-
-
-
-
-
-
- Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
-
-
- Open `index.mdx` and update the description in the frontmatter:
-
- ```mdx
- ---
- title: "Introduction"
- description: "Your custom description here"
- ---
- ```
-
-
- 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.