From 6ddb69ce4580389ac24eb27aa45b583afb5257e4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 27 Jan 2026 22:39:53 +0000 Subject: [PATCH 1/2] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 44 ++------------------------------------------ 1 file changed, 2 insertions(+), 42 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 7bfe62594..93bbcb09c 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,51 +4,11 @@ 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. - -## 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/). - - - Overview page of the Mintlify dashboard. - - Overview page of the Mintlify dashboard. - +Go to [mintlify.com/start](https://mintlify.com/start) to connect your GitHub account and create a repository for your documentation. After onboarding, your site is deployed 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 URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). ## Make your first change From c0ff8df96e407aff123c44bf9728f80febfe0f49 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 27 Jan 2026 22:40:03 +0000 Subject: [PATCH 2/2] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 86 +++++--------------------------------------------- 1 file changed, 8 insertions(+), 78 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 93bbcb09c..c56ec257d 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -12,86 +12,16 @@ Find your URL on the **Overview** page of your [dashboard](https://dashboard.min ## Make your first change - - - - - The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. +Edit `index.mdx` in the [web editor](https://dashboard.mintlify.com/editor) or locally with the [CLI](/installation): - - - ```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). - - - Open `index.mdx` in your preferred editor and update the description in the frontmatter: - - ```mdx - --- - title: "Introduction" - description: "Your custom description here" - --- - ``` - - - 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. - - - - - - - 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" +--- +``` - ```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. - - - - +Push your changes to deploy automatically. ## Next steps