From 7c9a00c53479dc95965e2aa1fccca2e0d7f4ed01 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 23 Jan 2026 22:27:42 +0000 Subject: [PATCH 1/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/quickstart.mdx b/quickstart.mdx index 7bfe62594..3f2fedb50 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,8 +4,18 @@ description: "Deploy your documentation site and make your first change." keywords: ["quickstart","deploy","get started","first steps"] --- +This guide takes approximately 5 minutes to complete. + After you complete this guide, you'll have a live documentation site ready to customize and update. +## Prerequisites + +Before starting, make sure you have: + +- A [GitHub account](https://github.com/signup) (GitLab and Bitbucket are also supported) +- [Node.js](https://nodejs.org/en) v20.17.0 or higher (only required for CLI usage) +- A code editor like [VS Code](https://code.visualstudio.com/) (only required for local development) + ## 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. From fc0e64e7b5fbf726472d27b54b313ef50071027f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 23 Jan 2026 22:27:48 +0000 Subject: [PATCH 2/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/quickstart.mdx b/quickstart.mdx index 3f2fedb50..b99dd9f5f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -16,7 +16,7 @@ Before starting, make sure you have: - [Node.js](https://nodejs.org/en) v20.17.0 or higher (only required for CLI usage) - A code editor like [VS Code](https://code.visualstudio.com/) (only required for local development) -## Before you begin +## How Mintlify works 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. From a1d61365c69a04af8895ae2340c3702143bb954d Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 23 Jan 2026 22:27:57 +0000 Subject: [PATCH 3/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/quickstart.mdx b/quickstart.mdx index b99dd9f5f..e5f4b4129 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -60,6 +60,10 @@ 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). + + **Success!** If you see your documentation site with the default Mintlify template, your deployment is working correctly. You're ready to make your first change. + + ## Make your first change From 64d648fbd4d4ce36fe1e578447b3c906a6775e24 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 23 Jan 2026 22:28:09 +0000 Subject: [PATCH 4/4] Update quickstart.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- quickstart.mdx | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/quickstart.mdx b/quickstart.mdx index e5f4b4129..23a127f3f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -147,6 +147,23 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa +## Troubleshooting + + + + Make sure you have admin permissions on the repository you're trying to connect. If you're part of an organization, you may need an organization admin to approve the GitHub App installation. + + + Mintlify CLI requires Node.js v20.17.0 or higher. Check your version with `node --version` and update if needed. We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage Node.js versions. + + + Deployments typically complete within 1-2 minutes. Check the deployment status on your [dashboard](https://dashboard.mintlify.com/). If the deployment shows an error, review the build logs for details. + + + Ensure you're running `mint dev` from the root of your documentation directory (where `docs.json` is located). If the port is in use, try `mint dev --port 3001`. + + + ## Next steps @@ -157,4 +174,10 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa Use your own domain for your documentation site. + + + Update colors, fonts, and logos to match your brand. + + + Learn MDX syntax and components to create rich documentation content. \ No newline at end of file