diff --git a/quickstart.mdx b/quickstart.mdx index 7bfe62594..23a127f3f 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -4,9 +4,19 @@ 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. -## Before you begin +## 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) + +## 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. @@ -50,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 @@ -133,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 @@ -143,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