From b25b1982b8c524ebdbe3955d085774329f3f3449 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 4 May 2026 17:26:32 +0000 Subject: [PATCH] Refine quickstart introduction and tooltip Mintlify-Source: dashboard-editor --- quickstart.mdx | 54 ++++++++++++++------------------------------------ 1 file changed, 15 insertions(+), 39 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index e63558ca3..e2fd93957 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -6,41 +6,31 @@ keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "se import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; -After you complete this guide, you'll have a live documentation site ready to customize and update. +After this guide, you'll have a live documentation site ready to customize. ## 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 project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. +Mintlify uses a docs-as-code approach: every page corresponds to a file in your documentation repository. Connect your repo to edit locally or in the web editor, then sync changes back to remote. - Using an AI coding tool? - - Copy the following prompt to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when updating your documentation. + Using an AI coding tool? Copy the prompt below to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when updating your documentation. ## 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 deploys and is accessible at your `.mintlify.app` URL. +Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding: connect your GitHub account, create or select a repository, and install the GitHub App for automatic deployments. Your site deploys to a `.mintlify.app` URL. - If you want to get started quickly without connecting your own repository, you can skip the Git provider 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. If you want to use your own repository later, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard to migrate your content using the Git setup wizard. See [Clone to your own repository](/deploy/github#clone-to-your-own-repository) for details. + To get started without your own repository, skip the Git provider connection. Mintlify creates a private repository and configures the GitHub App for you, so you can use the web editor immediately. To migrate to your own repository later, use the Git setup wizard in [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings). See [Clone to your own repository](/deploy/github#clone-to-your-own-repository) for details. ## 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/). +Find your `https://.mintlify.app` 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). + Use this URL for testing and team sharing. Add a [custom domain](/customize/custom-domain) before sharing with your users. ## Make your first change @@ -65,7 +55,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. + Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher (LTS recommended). @@ -79,13 +69,13 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - See [Install the CLI](/cli/install) for full details and troubleshooting. + See [Install the CLI](/cli/install) for troubleshooting. - If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/cli/install#clone-your-repository). + Follow [Clone your repository](/cli/install#clone-your-repository) if you haven't already. - - Open `index.mdx` in your preferred editor and update the description in the frontmatter: + + Update the `description` in `index.mdx`'s frontmatter, then run `mint dev` and view your preview at `http://localhost:3000`. ```mdx --- @@ -94,25 +84,14 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa --- ``` - - Run the following command from your documentation directory: - - ```bash - mint dev - ``` - - 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. + Mintlify deploys automatically. Track status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. @@ -137,11 +116,8 @@ 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. + + Click **Publish** in the top-right of the toolbar. Track deployment on the [Overview](https://dashboard.mintlify.com/) page, then refresh your site to see changes live.