diff --git a/quickstart.mdx b/quickstart.mdx index cf1ccb279..1d5bd5376 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -3,9 +3,7 @@ title: "Quickstart" description: "Deploy your documentation in minutes" --- -This quickstart guide shows you how to set up and deploy your documentation site in minutes. - -After completing this guide, you will have a live documentation site ready to customize and expand. +Set up and deploy your documentation site in minutes. @@ -15,26 +13,18 @@ After completing this guide, you will have a live documentation site ready to cu ## Getting started -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/). +After onboarding, your site deploys to `https://.mintlify.app`. Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/). Mintlify Domain Mintlify Domain -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. +Use this URL for testing and sharing with your team. ### Install the GitHub App -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 your dashboard. +Install the GitHub App to automate deployment when you push changes. 1. Navigate to **Settings** in your Mintlify dashboard. 2. Select **GitHub App** from the sidebar. @@ -63,7 +53,7 @@ Install the GitHub App by following the instructions from the onboarding checkli ## Editing workflows -Mintlify offers two workflows for creating and maintaining your documentation: +Choose your preferred workflow: For users who prefer working with existing tools in their local environment. Click to jump to this section. @@ -75,7 +65,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. +Work locally with your existing development tools and Git workflow. ### Install the CLI @@ -83,7 +73,7 @@ The code-based workflow integrates with your existing development environment an **Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher. -To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal: +Install the [mint](https://www.npmjs.com/package/mint) CLI: ```bash npm @@ -97,7 +87,7 @@ To work locally with your documentation, install the Command Line Interface (CLI ### Edit the documentation -After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page: +Edit your documentation files. For example, update the introduction page title: 1. Open your repository created during onboarding. 2. Open `index.mdx` and locate the top of the file: @@ -120,7 +110,7 @@ description: "This is the introduction to the documentation" ### Preview the changes -To preview the changes locally, run the following command: +Preview changes locally: ```bash mint dev @@ -135,11 +125,7 @@ Your preview will be available at `localhost:3000`. ### Push the changes -When you are ready to publish your changes, push them to your repository. - -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). - -After the deployment completes, your latest update will be available at `.mintlify.app`. +Push changes to your repository. Mintlify automatically builds and deploys updates. Monitor deployment status in your GitHub commit history or the [dashboard](https://dashboard.mintlify.com). Optionally, skip the web editor workflow and jump to adding a custom domain. @@ -147,7 +133,7 @@ After the deployment completes, your latest update will be available at ` Editing in Web Editor @@ -182,19 +164,17 @@ 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. +Select **Publish** in the top-right corner to deploy your changes. Use branches to preview and review changes through pull requests before deploying to your live site. -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). +See the [web editor documentation](/editor) for details on branches and pull requests. ## Adding a custom domain -While your `.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation. - -To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. +Add a custom domain for production. Navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard. Custom Domain @@ -215,7 +195,7 @@ Enter your domain (for example, `docs.yourcompany.com`) and follow the provided ## Next steps -Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation: +Your documentation site is live. Here are suggested next steps: Configure site-wide styling, navigation, integrations, and more with the `docs.json` file. @@ -235,7 +215,7 @@ Congratulations! You have successfully deployed your documentation site with Min ## Troubleshooting -If you encounter issues during the setup process, check these common troubleshooting solutions: +Common troubleshooting solutions: