From acab6ef51e60feacda16251d05991ed31c60cc3c Mon Sep 17 00:00:00 2001
From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com>
Date: Tue, 3 Feb 2026 02:27:02 +0000
Subject: [PATCH] Update quickstart.mdx
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
---
quickstart.mdx | 127 ++++++++-----------------------------------------
1 file changed, 20 insertions(+), 107 deletions(-)
diff --git a/quickstart.mdx b/quickstart.mdx
index bc56bad0b..f88b53a1e 100644
--- a/quickstart.mdx
+++ b/quickstart.mdx
@@ -1,83 +1,35 @@
---
title: "Quickstart"
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
-
-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.
-
-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 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).
-
+Go to [mintlify.com/start](https://mintlify.com/start) to deploy your documentation site. Connect your GitHub account and select a repository. Your site deploys at `https://.mintlify.app`.
## Make your first change
+
+
+
+ Navigate to the [web editor](https://dashboard.mintlify.com/editor).
+
+
+ Open the **Introduction** page and update the description.
+
+
+ Click **Publish** in the top-right toolbar.
+
+
+
- The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.
-
-
-
- ```bash npm
+ ```bash
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).
- Open `index.mdx` in your preferred editor and update the description in the frontmatter:
+ Open `index.mdx` and update the description:
```mdx
---
@@ -86,50 +38,11 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
---
```
-
- Run the following command from your documentation directory:
-
+
```bash
mint dev
+ git add . && git commit -m "Update description" && git push
```
-
- View your preview at `http://localhost:3000`.
-
-
- Commit and push your changes to trigger a deployment:
-
- ```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 the **Introduction** page and update the description.
-
-
- 
- 
-
-
-
- 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.
@@ -138,10 +51,10 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
## Next steps
- Edit documentation in your browser and preview how your pages will look when published.
+ Edit documentation in your browser and preview changes.
- Find broken links, check accessibility, validate OpenAPI specs, and more.
+ Find broken links, check accessibility, and validate OpenAPI specs.
Use your own domain for your documentation site.