From 0d1594ddd64308c597cc1ee259e2b99d4f19407c Mon Sep 17 00:00:00 2001 From: "mintlify-development[bot]" <109878554+mintlify-development[bot]@users.noreply.github.com> Date: Wed, 28 Jan 2026 00:56:12 +0000 Subject: [PATCH] Simplify quickstart page for better user experience - Streamlined intro from complex explanation to simple promise - Converted deployment to clear 4-step process - Prioritized web editor workflow over CLI for beginners - Simplified editing steps and removed decision fatigue - Updated next steps to focus on actionable customization tasks --- quickstart.mdx | 156 ++++++++++++++----------------------------------- 1 file changed, 45 insertions(+), 111 deletions(-) diff --git a/quickstart.mdx b/quickstart.mdx index 7bfe62594..803293046 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,33 +4,24 @@ description: "Deploy your documentation site and make your first change." keywords: ["quickstart","deploy","get started","first steps"] --- -After you complete this guide, you'll have a live documentation site ready to customize and update. +Get a live documentation site up and running in minutes. -## Before you begin +## Deploy your site -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. +1. Go to [mintlify.com/start](https://mintlify.com/start) +2. Connect your GitHub account +3. Create a new repository or select an existing one +4. Complete the onboarding process -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 site is automatically deployed to `https://.mintlify.app`. -## 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 + + Want to start without connecting GitHub? You can skip the GitHub connection during onboarding. Mintlify will create a private repository for you, and you can migrate to your own repository later. + -Your documentation site is now deployed at `https://.mintlify.app`. +## Find your site URL -Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/). +View your live site 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). - - ## Make your first change - - - - - The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability. - - + + + Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. + + + Open `index.mdx` and update the description: + + ```mdx + --- + title: "Introduction" + description: "Your custom description here" + --- + ``` + + + Click **Publish** in the top-right corner. + + + Check your site to see the updated description live. + + - ```bash npm - npm i -g mint - ``` - - - ```bash pnpm - pnpm add -g mint - ``` - - - - 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). - - - 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 `index.mdx` and update the description in the frontmatter: - - ```mdx - --- - title: "Introduction" - description: "Your custom description here" - --- - ``` - - - 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. - - - - + + + Prefer working locally? [Install the CLI](/installation) to edit files in your preferred editor and preview changes with `mint dev`. + + ## Next steps - - Edit documentation in your browser and preview how your pages will look when published. + + Change colors, add your logo, and make it your own. + + + Create new pages and organize your content. - - Find broken links, check accessibility, validate OpenAPI specs, and more. + + Use your own domain instead of `.mintlify.app`. - - Use your own domain for your documentation site. - \ No newline at end of file