From e322091a4781e9ab7fe2560d3602b0e77dd336bc Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 11 Mar 2026 15:25:26 +0000 Subject: [PATCH 1/2] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 73 ++++---------------------------------------------- 1 file changed, 5 insertions(+), 68 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index b81984a99..8f110dc31 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,81 +1,18 @@ --- 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. +Deploy your documentation site in minutes and make your first edit. -## 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. +Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding. You'll connect your GitHub account, select a repository, and install the GitHub App. -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. +Your site deploys automatically at `https://.mintlify.app`. - 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. - - - -Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices: - -npx skills add https://mintlify.com/docs - -Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md - - -## Deploy your documentation site - - - If your code or documentation is already in a public GitHub repository, [auto-generate your documentation site](https://mintlify.com/explore) instead. - - Replace `github.com` with `mintlify.com` in any public repository URL: - - ``` - https://mintlify.com/github-org/repo-name - ``` - - -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. - - - - 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. - - - - 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). + Already have a public GitHub repository? [Auto-generate your docs](https://mintlify.com/explore) by replacing `github.com` with `mintlify.com` in your repo URL. ## Make your first change From 8884613987f1dcf73b3dd603e4104734f0b1fda5 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Wed, 11 Mar 2026 15:25:39 +0000 Subject: [PATCH 2/2] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 96 +++++++------------------------------------------- 1 file changed, 13 insertions(+), 83 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 8f110dc31..47da0e152 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -15,93 +15,23 @@ Your site deploys automatically at `https://.mintlify.app`. Already have a public GitHub repository? [Auto-generate your docs](https://mintlify.com/explore) by replacing `github.com` with `mintlify.com` in your repo URL. -## Make your first change +## Make your first edit - - - - 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). - - - 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 the **Introduction** page and update the description. - - - Introduction page open in the web editor with the description edited to say Hello world!. + 1. Open the [web editor](https://dashboard.mintlify.com/editor) + 2. Edit the **Introduction** page description + 3. Click **Publish** + 4. View your changes live at your site URL + + + 1. Install the CLI: `npm i -g mint` + 2. Clone your repository locally + 3. Edit `index.mdx` and update the description + 4. Preview with `mint dev` + 5. Push your changes: `git push` - Introduction page open in the web editor with the description edited to say Hello world!. - - - - 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. - - + See [CLI installation](/installation) for details.