Skip to content

test #5609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 5 commits into
base: main
Choose a base branch
from
+46 −107
Open

test #5609

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
97aaf2f
Update Quickstart page content
mintlify[bot] Apr 30, 2026
7b0dda5
Simplify quickstart introduction
mintlify[bot] Apr 30, 2026
0c86d13
Update quickstart.mdx for Mintlify casing
mintlify[bot] Apr 30, 2026
4dab71a
Remove extra newline from quickstart.mdx
mintlify[bot] Apr 30, 2026
c2683ad
Rewrite Quickstart page with rich MDX components
mintlify[bot] Apr 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 46 additions & 107 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,108 +1,35 @@
---
title: "Quickstart"
description: "Get started with Mintlify by deploying your documentation site in minutes and making your first content change with the web editor or Git."
keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"]
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
---

After you complete this guide, you'll have a live documentation site ready to customize and update.

Comment thread
cursor[bot] marked this conversation as resolved.
## 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 <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.

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.

<Tip>
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.
</Tip>

<Prompt description="Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md" actions={["copy", "cursor"]}>
Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

npx skills add https://mintlify.com/docs

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md
</Prompt>

## Deploy your documentation site

<Tip>
If your code or documentation is already in a public GitHub repository, [auto-generate your documentation site](https://mintlify.com/explore) instead.

Replace `github.com` with `mintlify.com` in any public repository URL:

```
https://mintlify.com/github-org/repo-name
```
</Tip>

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.

<AccordionGroup>
<Accordion title="Optional: Skip connecting a Git provider during onboarding">
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.
</Accordion>
</AccordionGroup>

## View your deployed site

Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.

Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

<Frame>
<img
src="/images/quickstart/mintlify-domain-light.png"
alt="Overview page of the Mintlify dashboard."
className="block dark:hidden"
/>

<img
src="/images/quickstart/mintlify-domain-dark.png"
alt="Overview page of the Mintlify dashboard."
className="hidden dark:block"
/>
</Frame>

<Tip>
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).
</Tip>

## Make your first change

<Tabs>
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.
The CLI requires Node.js v20.17.0 or higher. Use an LTS version for stability.

<CodeGroup>

```bash npm
npm i -g mint
```


```bash pnpm
pnpm add -g mint
```

</CodeGroup>

See [Install the CLI](/cli/install) for full details and troubleshooting.
<Tip>
See [Install the CLI](/installation) for full details and troubleshooting.
</Tip>
</Step>
<Step title="Clone your repository">
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/cli/install#clone-your-repository).
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/settings/github).
</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:
Expand All @@ -121,7 +48,7 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
mint dev
```

View your preview at `http://localhost:3000`.
View your preview at [http://localhost:3000](http://localhost:3000).
</Step>
<Step title="Push your changes">
Commit and push your changes to trigger a deployment:
Expand All @@ -132,52 +59,64 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
git push
```

Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
Mintlify automatically deploys your changes. View your deployment status on the **Overview** page of your dashboard.
</Step>
</Steps>
</Tab>
<Tab title="Web editor">
<Steps>
<Step title="Open the web editor">
Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
Navigate to the [web editor](https://dashboard.mintlify.com) in your dashboard.
Copy link
Copy Markdown

@cursor cursor Bot Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Web editor link drops /editor path from URL

Medium Severity

The "Open the web editor" step changed the URL from https://dashboard.mintlify.com/editor to https://dashboard.mintlify.com, dropping the /editor path. Every other reference to the web editor across the codebase (including guides/git-concepts.mdx and all translated quickstart pages) still uses dashboard.mintlify.com/editor. This sends users to the general dashboard homepage instead of directly to the web editor.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit c2683ad. Configure here.

</Step>
<Step title="Edit a page">
Open the **Introduction** page and update the description.

<Frame>
<img
src="/images/quickstart/hello-world-light.png"
alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="block dark:hidden"
/>

<img
src="/images/quickstart/hello-world-dark.png"
alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="hidden dark:block"
/>
</Frame>
Open the Introduction page and update the description.
</Step>
<Step title="Publish">
Click the **Publish** button in the top-right of the web editor toolbar.
</Step>
<Step title="View live">
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.
On the **Overview** 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.
</Step>
</Steps>
</Tab>
</Tabs>

## Next steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages look when published.
</Card>
<CardGroup cols={3}>
<Card title="Use the web editor" icon="pen-to-square" href="/web-editor">
Copy link
Copy Markdown

@cursor cursor Bot Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken internal link to nonexistent /web-editor page

High Severity

The "Use the web editor" card links to /web-editor, but no page exists at that path — there's no web-editor.mdx file in the repo and no redirect entry in redirects.json. The actual web editor overview page lives at editor/index.mdx (previously linked as /editor/index). This will result in a 404 for users clicking the card in the "Next steps" section.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit c2683ad. Configure here.

Edit documentation in your browser and preview how your pages look when published.
</Card>

<Card title="Explore CLI commands" icon="terminal" href="/cli">
Find broken links, check accessibility, validate OpenAPI specs, and more.
</Card>

<Card title="Explore CLI commands" icon="terminal" horizontal href="/cli/index">
Find broken links, check accessibility, validate OpenAPI specs, and more.
</Card>
<Card title="Add a custom domain" icon="globe" href="/settings/custom-domain">
Use your own domain for your documentation site.
</Card>
</CardGroup>

<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
## AI-assisted editing

<AccordionGroup>
<Accordion title="Cursor / VS Code">
Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

```bash
npx skills add https://mintlify.com/docs
```

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at [mintlify.com/docs/ai/model-context-protocol](https://www.mintlify.com/docs/ai/model-context-protocol.md).
</Accordion>

<Accordion title="Other AI editors">
Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:

```bash
npx skills add https://mintlify.com/docs
```

Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at [mintlify.com/docs/ai/model-context-protocol](https://www.mintlify.com/docs/ai/model-context-protocol.md).
</Accordion>
Copy link
Copy Markdown

@cursor cursor Bot Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicate accordion content for different AI editors

Low Severity

The "Cursor / VS Code" and "Other AI editors" accordions contain identical content — same instructions, same commands, same links. Having two separate accordions implies differentiated instructions, but they're exact copies. This is likely placeholder content where the "Other AI editors" section was meant to contain different or more generic guidance.

Additional Locations (1)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit c2683ad. Configure here.

</AccordionGroup>