diff --git a/quickstart.mdx b/quickstart.mdx index 8e2cb6b5e..9d60080ab 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -7,41 +7,31 @@ boost: 3 import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx"; -After you complete this guide, you'll have a live documentation site ready to customize and update. +Deploy a live documentation site and make your first change. ## 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 project, you can work on your documentation locally or in the web editor and sync any changes to your remote repository. +Mintlify uses a docs-as-code approach: every page has a corresponding file in your documentation repository. Edit locally or in the web editor and sync changes to your remote repository. - Using an AI coding tool? - - Copy the following prompt to add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results when updating your documentation. + Using an AI coding tool? Add the Mintlify [skill](/ai/skillmd) and [MCP server](/ai/model-context-protocol) for better results. ## 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 deploys and is accessible at your `.mintlify.app` URL. +Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. You'll connect GitHub, create or select a repository, and install the GitHub App for automatic deployments. Your site deploys to a `.mintlify.app` URL. - If you want to get started quickly without connecting your own repository, you can skip the Git provider 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. If you want to use your own repository later, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard to migrate your content using the Git setup wizard. See [Clone to your own repository](/deploy/github#clone-to-your-own-repository) for details. + Skip the Git connection to get started immediately. Mintlify creates a private repository for you so you can use the web editor right away. Migrate to your own repository later from [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings). See [Clone to your own repository](/deploy/github#clone-to-your-own-repository). ## 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/). +Find your URL at `https://.mintlify.app` 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). + Before sharing with users, add a [custom domain](/customize/custom-domain). ## Make your first change @@ -66,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. + Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. @@ -80,13 +70,13 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa - See [Install the CLI](/cli/install) for full details and troubleshooting. + See [Install the CLI](/cli/install) for details. - If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/cli/install#clone-your-repository). + Follow [Clone your repository](/cli/install#clone-your-repository) if you haven't already. - Open `index.mdx` in your preferred editor and update the description in the frontmatter: + Update the description in `index.mdx`: ```mdx --- @@ -96,31 +86,23 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ``` - Run the following command from your documentation directory: - - ```bash - mint dev - ``` - - View your preview at `http://localhost:3000`. + Run `mint dev` and open `http://localhost:3000`. - Commit and push your changes to trigger a deployment: - ```bash git add . git commit -m "Update description" git push ``` - Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. + Mintlify deploys automatically. Check status on the [Overview](https://dashboard.mintlify.com/) page. - Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. + Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. Open the **Introduction** page and update the description. @@ -132,17 +114,17 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa src="/images/quickstart/hello-world-light.png" /> Introduction page open in the web editor with the description edited to say Hello world!. - Click **Publish** in the top-right of the web editor toolbar. + Click **Publish** in the top-right 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, then refresh your site. @@ -160,4 +142,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 +