From 8f11a3e1160ad519d62b52f9918cd7dd9e267eb9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:47:35 +0000 Subject: [PATCH 1/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 30 ++---------------------------- 1 file changed, 2 insertions(+), 28 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index e4ca755d7..84702a424 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,37 +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. +Deploy a live documentation site in minutes. ## 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. You can use your own Git repository or a Mintlify-hosted repository. - -Choose your repository approach. - - - - Mintlify creates a private GitHub repository connected to your Mintlify deployment. - - Choose this option if: - - You will only work in the web editor and don't want to use Git locally. - - You want to get started quickly without connecting a repository. - - You want Mintlify to manage your documentation repository for you. - - - - Connect your own Git repository to your Mintlify deployment. - - Choose this option if: - - You will work locally and want to sync to your remote repository. - - You already have a repository for your documentation. - - You want your documentation to be under your own GitHub organization. - - - - - Not sure which to choose? Start with **Mintlify-hosted**. You can migrate to your own repository anytime if it better suits your needs. - +Choose between a Mintlify-hosted repository (quick start, web editor only) or your own Git repository (local development, full control). ## Deploy your documentation site From 62ecddb8d355d20c0a59436d8a24d97b5f10ce5c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:47:46 +0000 Subject: [PATCH 2/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 62 ++++++++++++-------------------------------------- 1 file changed, 15 insertions(+), 47 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 84702a424..35c313d8a 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -10,53 +10,21 @@ Deploy a live documentation site in minutes. Choose between a Mintlify-hosted repository (quick start, web editor only) or your own Git repository (local development, full control). -## Deploy your documentation site - - - - - - Go to [mintlify.com/start](https://mintlify.com/start) and create your account. - - - When prompted to connect GitHub, click **Skip** to use a Mintlify-hosted repository. - - - Follow the onboarding prompts to set up your documentation. Mintlify automatically creates a private repository in the `mintlify-community` organization and configures the GitHub app for you. - - - Your documentation is immediately deployed and accessible at your `.mintlify.app` URL. - - - - - - - - Go to [mintlify.com/start](https://mintlify.com/start) and create your account. - - - When prompted, log in to your GitHub account and authenticate. - - - Follow the remaining onboarding prompts to create a repository and continue to your dashboard. - - - Install the Mintlify [GitHub App](https://dashboard.mintlify.com/api/github/install-app) to enable automatic deployments. This allows Mintlify to sync with your repository and deploy changes automatically when you push. - - - If you want to use a different repository than the one created during onboarding for your documentation, select it on the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. Your documentation repository must have a valid `docs.json` file to deploy. - - - Your documentation is deployed and accessible at your `.mintlify.app` URL. Future changes pushed to your repository will automatically trigger new deployments. - - - - - To learn more about the GitHub App and its permissions, see [GitHub](/deploy/github). - - - +## Deploy your site + + + + Go to [mintlify.com/start](https://mintlify.com/start). + + + Click **Skip** for Mintlify-hosted, or connect your GitHub account for your own repository. + + + Follow onboarding prompts. For your own repository, install the [GitHub App](https://dashboard.mintlify.com/api/github/install-app). + + + +Your site deploys to `https://.mintlify.app`. ## View your deployed site From 36a1d296dba2d38345f94035fa748b8db72972cc Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:47:52 +0000 Subject: [PATCH 3/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 24 +----------------------- 1 file changed, 1 insertion(+), 23 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 35c313d8a..b12353245 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -26,29 +26,7 @@ Choose between a Mintlify-hosted repository (quick start, web editor only) or yo Your site deploys to `https://.mintlify.app`. -## 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). - +Find your URL on the [dashboard](https://dashboard.mintlify.com/) **Overview** page. ## Make your first change From 0b82d411aaf2f23c4d88296daeb8086fe7a20099 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:47:58 +0000 Subject: [PATCH 4/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index b12353245..e86054d45 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -30,27 +30,10 @@ Find your URL on the [dashboard](https://dashboard.mintlify.com/) **Overview** p ## Make your first change - - - 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" - --- - ``` - - - 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. - - +1. Open the [web editor](https://dashboard.mintlify.com/editor) +2. Edit `index.mdx` and update the description +3. Click **Publish** +4. View your changes live after deployment completes ## Next steps