diff --git a/quickstart.mdx b/quickstart.mdx index e4ca755d7..76e475868 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,39 +4,37 @@ 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 and make your first change. -## Before you begin +## Choose your 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. You can use your own Git repository or a Mintlify-hosted repository. - -Choose your repository approach. +Mintlify uses a docs-as-code approach. 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. - Mintlify creates a private GitHub repository connected to your Mintlify deployment. + Mintlify creates a private GitHub repository connected to your 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. + **Choose this if:** + - You only work in the web editor + - You want to get started quickly + - You want Mintlify to manage your repository - Connect your own Git repository to your Mintlify deployment. + Connect your own Git repository to your 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. + **Choose this if:** + - You work locally and sync to your remote repository + - You already have a documentation repository + - You want documentation under your 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. + Start with **Mintlify-hosted**. You can migrate to your own repository anytime. -## Deploy your documentation site +## Deploy your site @@ -45,13 +43,13 @@ Choose your repository approach. 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. + Click **Skip** when prompted to connect GitHub. - 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. + Follow the onboarding prompts. Mintlify creates a private repository in the `mintlify-community` organization and configures the GitHub app. - Your documentation is immediately deployed and accessible at your `.mintlify.app` URL. + Your documentation is deployed at your `.mintlify.app` URL. @@ -62,33 +60,33 @@ Choose your repository approach. Go to [mintlify.com/start](https://mintlify.com/start) and create your account. - When prompted, log in to your GitHub account and authenticate. + Log in to your GitHub account and authenticate. - Follow the remaining onboarding prompts to create a repository and continue to your dashboard. + Follow the onboarding prompts to create a repository. - 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. + Install the [GitHub App](https://dashboard.mintlify.com/api/github/install-app) to enable automatic deployments. - 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. + To use a different repository, select it on the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page. Your repository must have a valid `docs.json` file. - Your documentation is deployed and accessible at your `.mintlify.app` URL. Future changes pushed to your repository will automatically trigger new deployments. + Your documentation is deployed at your `.mintlify.app` URL. Future changes automatically trigger new deployments. - To learn more about the GitHub App and its permissions, see [GitHub](/deploy/github). + Learn more about the GitHub App at [GitHub](/deploy/github). -## View your deployed site +## View your site -Your documentation site is now deployed at `https://.mintlify.app`. +Your site is deployed at `https://.mintlify.app`. -Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). +Find your URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). - 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). + Use this URL for testing and sharing with your team. Add a [custom domain](/customize/custom-domain) before sharing with users. ## Make your first change - Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. + Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. - Open `index.mdx` and update the description in the frontmatter: + Open `index.mdx` and update the description: ```mdx --- @@ -125,10 +123,10 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ``` - Click the **Publish** button in the top-right of the web editor toolbar. + Click **Publish** in the top-right 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. + Check deployment status on the [Overview](https://dashboard.mintlify.com/) page. Refresh your site to see your changes.