diff --git a/quickstart.mdx b/quickstart.mdx index bc56bad0b..a9fb913db 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,33 +4,33 @@ 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. +Complete this guide to deploy a live documentation site. ## 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. +Mintlify uses a docs-as-code approach. Each page has a corresponding file in your documentation repository. -When you connect your documentation repository to your Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. +Connect your repository to your Mintlify deployment to work locally or in the web editor and sync changes to your remote repository. ## 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. +Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. Connect your GitHub account, create or select a repository, and install the GitHub App to enable automatic deployments. -After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL. +Your site deploys to 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. + Skip the GitHub connection to get started quickly. Mintlify creates a private repository and configures the GitHub App automatically. - This lets you use the web editor immediately and migrate to your own repository later. + 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`. +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 @@ -56,7 +56,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. + The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. @@ -71,10 +71,10 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - See [Install the CLI](/installation) for full details and troubleshooting. + See [Install the CLI](/installation) for details and troubleshooting. - If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). + 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: @@ -87,7 +87,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ``` - Run the following command from your documentation directory: + Run from your documentation directory: ```bash mint dev @@ -96,7 +96,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa View your preview at `http://localhost:3000`. - Commit and push your changes to trigger a deployment: + Commit and push to trigger a deployment: ```bash git add . @@ -104,7 +104,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa git push ``` - Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. + Mintlify automatically deploys your changes. View deployment status on the [Overview](https://dashboard.mintlify.com/) page. @@ -129,7 +129,7 @@ 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. - 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. When deployment finishes, refresh your site to see changes live.