diff --git a/quickstart.mdx b/quickstart.mdx index 6dc61ae8d..abf19eeef 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -36,11 +36,13 @@ Find your URL on the Overview page of your [dashboard](https://dashboard.mintlif Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site. -### Install the GitHub App +### Connect your GitHub repository -Mintlify provides a GitHub App that automates deployment when you push changes to your repository. +Mintlify integrates directly with GitHub to automatically deploy your documentation when you push changes to your repository. This Git-based workflow ensures your documentation stays in sync with your codebase and enables version control, collaboration, and review processes. -Install the GitHub App by following the instructions from the onboarding checklist or your dashboard. +#### Install the GitHub App + +The Mintlify GitHub App monitors your repository for changes and triggers automatic deployments. 1. Navigate to **Settings** in your Mintlify dashboard. 2. Select **GitHub App** from the sidebar. @@ -66,7 +68,7 @@ Install the GitHub App by following the instructions from the onboarding checkli 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. @@ -90,7 +92,7 @@ Mintlify offers two workflows for creating and maintaining your documentation: ## Code-based workflow -The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code. +The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code using familiar Git-based version control. ### Install the CLI @@ -166,12 +168,22 @@ Your preview is available at `localhost:3000`. ### Push the changes -When you are ready to publish your changes, push them to your repository. +When you are ready to publish your changes, commit and push them to your GitHub repository: + +```bash +git add . +git commit -m "Update introduction title" +git push origin main +``` -Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com). +Mintlify automatically detects the changes through the GitHub App, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com). After the deployment completes, your latest update will be available at `.mintlify.app`. + + Use Git branches and pull requests to review changes before merging to your main branch. Learn more about [working with branches](/guides/branches). + + Optionally, skip the web editor workflow and jump to adding a custom domain. @@ -233,10 +245,10 @@ Then, in the editor, update the title field to "Hello World". ### Publish your changes -When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site. +When you're satisfied with your edits, select the **Publish** button in the top-right corner. The web editor commits your changes to your GitHub repository and triggers an automatic deployment to your documentation site. - Use branches to preview and review changes through pull requests before deploying to your live site. + Use Git branches to preview and review changes through pull requests before deploying to your live site. The web editor supports creating and switching between branches. For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor).