diff --git a/quickstart.mdx b/quickstart.mdx index 25d519d91..85b014ec5 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -6,48 +6,14 @@ keywords: ["quickstart","deploy","get started","first steps"] After you complete this guide, you'll have a live documentation site ready to customize and update. -## 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. - -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. - ## 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. -After 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. - - - -## View your deployed site - -Your documentation site is now deployed at `https://.mintlify.app`. - -Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). - - - Overview page of the Mintlify dashboard. - - Overview page of the Mintlify dashboard. - +After onboarding, your documentation site is deployed and accessible at `https://.mintlify.app`. Find your exact 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). + Your site is ready to view immediately. Before sharing with users, you may want to add a [custom domain](/customize/custom-domain). ## Make your first change @@ -56,7 +22,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. @@ -70,8 +36,6 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ``` - - See [Install the CLI](/installation) for full details and troubleshooting. If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). @@ -145,4 +109,4 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa Use your own domain for your documentation site. - \ No newline at end of file +