diff --git a/quickstart.mdx b/quickstart.mdx index bc56bad0b..aa8bd7884 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -8,23 +8,29 @@ After you complete this guide, you'll have a live documentation site ready to cu ## 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. +You'll need a GitHub account to deploy your documentation site. Mintlify uses a docs-as-code approach where every page on your site has a corresponding file stored 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. +Your documentation repository connects to your Mintlify deployment, allowing you to work locally or in the web editor and sync changes automatically. ## 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) to begin the onboarding process. + + + Connect your GitHub account and create or select a repository for your documentation. + + + Install the Mintlify GitHub App to enable automatic deployments when you push changes. + + -After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL. +After completing onboarding, your documentation site is deployed and accessible at 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. - - This lets you use the web editor immediately and migrate to your own repository later. - - + + Want to get started quickly? You can skip connecting your own repository during onboarding. Mintlify will create a private repository for you, letting you use the web editor immediately and migrate to your own repository later. + ## View your deployed site @@ -46,9 +52,9 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa /> - - 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). - + + Your site is live and ready to view. 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 @@ -137,12 +143,23 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ## Next steps - - Edit documentation in your browser and preview how your pages will look when published. - - - Find broken links, check accessibility, validate OpenAPI specs, and more. - - - Use your own domain for your documentation site. - \ No newline at end of file + + + Edit documentation in your browser and preview how your pages will look when published. + + + Find broken links, check accessibility, validate OpenAPI specs, and more. + + + Use your own domain for your documentation site. + + + Configure colors, fonts, and branding to match your product. + + + Structure your documentation with groups, tabs, and sections. + + + Auto-generate interactive API reference from your OpenAPI spec. + + \ No newline at end of file