diff --git a/quickstart.mdx b/quickstart.mdx index 9fd62d06e..554ffefec 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -8,8 +8,6 @@ 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. -/ - ## 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. @@ -76,74 +74,59 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa ``` ```bash pnpm - pnpm add -g mint ``` - See [Install the CLI](/cli/install) for full details and troubleshooting. - - - If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/cli/install#clone-your-repository). - - - Open `index.mdx` in your preferred editor and update the description in the frontmatter: - - ```mdx - --- - title: "Introduction" - description: "Your custom description here" - --- - ``` - - - Run the following command from your documentation directory: - - ```bash - mint dev - ``` - - View your preview at `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. - - - - - - - Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. - - - Open the **Introduction** page and update the description. - - - Introduction page open in the web editor with the description edited to say Hello world!. - Introduction page open in the web editor with the description edited to say Hello world!. - - - - Click the **Publish** button in the top-right of the web editor 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. + + + + + + ```bash pnpm + ``` + + + + See [Install the CLI](/cli/install) for full details and troubleshooting. + + + If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/cli/install#clone-your-repository). + + + Open `index.mdx` in your preferred editor and update the description in the frontmatter: + + ```mdx + --- + title: "Introduction" + description: "Your custom description here" + --- + ``` + + + Run the following command from your documentation directory: + + ```bash + mint dev + ``` + + View your preview at `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. + + + + +