From 2c0c74f6f6219851337d378b8a015a5c4b9d12ee Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 24 Feb 2026 23:13:48 +0000 Subject: [PATCH 1/3] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 63 +++----------------------------------------------- 1 file changed, 3 insertions(+), 60 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index ace9750de..dac86b69c 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -1,70 +1,13 @@ --- 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 site -## Before you begin +Go to [mintlify.com/start](https://mintlify.com/start) to create your documentation site. Connect your GitHub account and select a repository. -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. - - - 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. - - - -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 - -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. - - - - 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). - +Your site deploys automatically to `https://.mintlify.app`. ## Make your first change From c58384037c0c48d999e995498b669c595831930e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 24 Feb 2026 23:13:59 +0000 Subject: [PATCH 2/3] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 97 ++++++++++---------------------------------------- 1 file changed, 19 insertions(+), 78 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index dac86b69c..011b810ec 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -12,90 +12,31 @@ Your site deploys automatically to `https://.mintlify.app`. ## Make your first change + + 1. Open the [web editor](https://dashboard.mintlify.com/editor) + 2. Edit the **Introduction** page + 3. Click **Publish** + - - - 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 - ``` - - + Install the CLI: - 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: + ```bash + npm i -g mint + ``` - ```mdx - --- - title: "Introduction" - description: "Your custom description here" - --- - ``` - - - Run the following command from your documentation directory: + Edit `index.mdx` and preview locally: - ```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. + ```bash + mint dev + ``` - - Introduction page open in the web editor with the description edited to say Hello world!. + Push your changes: - 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. - - + ```bash + git add . + git commit -m "Update description" + git push + ``` From 1c77559a995cf753233319dcef1d10e30978fb19 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Tue, 24 Feb 2026 23:14:06 +0000 Subject: [PATCH 3/3] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 011b810ec..a55da158c 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -42,14 +42,17 @@ Your site deploys automatically to `https://.mintlify.app`. ## Next steps - - Edit documentation in your browser and preview how your pages will look when published. - - - - Find broken links, check accessibility, validate OpenAPI specs, and more. - - - - Use your own domain for your documentation site. - \ No newline at end of file + + + Edit in your browser + + + Work locally + + + Add your domain + + + Organize your pages + + \ No newline at end of file