diff --git a/quickstart.mdx b/quickstart.mdx index 981c33cc..f07d1cd8 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,29 +4,31 @@ description: "Deploy your documentation in minutes" icon: "rocket" --- -This quickstart guide shows you how to set up and deploy your documentation site in minutes. +# Quickstart Guide -After you complete this guide, you will have a live documentation site ready to customize and expand. +Deploy your documentation site in minutes with this step-by-step guide. + +After completing this guide, you'll have a live documentation site ready to customize and expand. -**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding. +**Prerequisites**: Before you begin, [create a Mintlify account](https://mintlify.com/start) and complete onboarding. -## Getting Started +## Set Up Your Documentation Site -After you complete the onboarding process, your documentation site will automatically deploy to a unique URL with this format: +After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format: ``` https://.mintlify.app ``` -Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). +Find your URL on the Overview page of your [Mintlify dashboard](https://dashboard.mintlify.com/). - Mintlify Domain - Mintlify Domain + Screenshot of Mintlify dashboard showing the unique project URL in light mode + Screenshot of Mintlify dashboard showing the unique project URL in dark mode This URL becomes available immediately and updates when you make changes to your documentation. Use this URL for testing and sharing with your team during development. @@ -35,27 +37,28 @@ This URL becomes available immediately and updates when you make changes to your Mintlify provides a GitHub App that automates deployment when you push changes to your repository. -Install the GitHub App by following the instructions from the onboarding checklist or from your dashboard. +Install the GitHub App by following these steps: -1. Navigate to **Settings** in your Mintlify dashboard. -2. Select **GitHub App** from the sidebar. -3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page. -4. Select the organization or user account where you want to install the app. Then select the repositories that you want to connect. +1. Navigate to **Settings** in your Mintlify dashboard +2. Select **GitHub App** from the sidebar +3. Select **Install GitHub App** (opens a new tab to the GitHub App installation page) +4. Select the organization or user account where you want to install the app +5. Select the repositories you want to connect - GitHub App Installation - GitHub App Installation + Screenshot of GitHub App installation page showing repository selection in light mode + Screenshot of GitHub App installation page showing repository selection in dark mode Update the GitHub App permissions if you move your documentation to a different repository. -### Authorize your GitHub Account +### Authorize Your GitHub Account -1. Navigate to **Settings** in your Mintlify dashboard. -2. Select **My Profile** from the sidebar. -3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page. +1. Navigate to **Settings** in your Mintlify dashboard +2. Select **My Profile** from the sidebar +3. Select **Authorize GitHub account** (opens a new tab to the GitHub authorization page) An admin for your GitHub organization may need to authorize your account depending on your organization settings.