Skip to content

Quickstart guide updates #5634

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

Closed
dks333 wants to merge 1 commit into from
Closed

Quickstart guide updates #5634

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
115 changes: 49 additions & 66 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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>.
Expand Down Expand Up @@ -76,74 +74,59 @@ Find your exact URL on the **Overview** page of your [dashboard](https://dashboa
```

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

</CodeGroup>

See [Install the CLI](/cli/install) for full details and troubleshooting.
</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).
</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:

```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
</Step>
<Step title="Preview locally">
Run the following command from your documentation directory:

```bash
mint dev
```

View your preview at `http://localhost:3000`.
</Step>
<Step title="Push your changes">
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.
</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.
</Step>
<Step title="Edit a page">
Open the **Introduction** page and update the description.

<Frame>
<img
Copy link
Copy Markdown

@cursor cursor Bot May 1, 2026

Choose a reason for hiding this comment

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

Tab components incorrectly nested inside Step element

High Severity

<Tab title="CLI"> and <Tab title="Web editor"> are nested inside the <Step title="Install the CLI"> element (which itself is inside the outer <Tab title="CLI">). This creates an invalid component hierarchy — Tab components aren't designed to be children of Step components. The entire "Make your first change" section structure is broken, likely causing rendering issues or a broken page layout.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 9dcc6a8. Configure here.

alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="block dark:hidden"
src="/images/quickstart/hello-world-light.png"
/>
<img
alt="Introduction page open in the web editor with the description edited to say Hello world!."
className="hidden dark:block"
src="/images/quickstart/hello-world-dark.png"
/>
</Frame>
</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.
<Tab title="CLI">
<Steps>
<Step>
<CodeGroup>

```bash pnpm
```

</CodeGroup>

See [Install the CLI](/cli/install) for full details and troubleshooting.
</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).
</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:

```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
</Step>
<Step title="Preview locally">
Run the following command from your documentation directory:

```bash
mint dev
```

View your preview at `http://localhost:3000`.
</Step>
<Step title="Push your changes">
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.
</Step>
</Steps>
</Tab>
<Tab title="Web editor">
</Tab>
</Step>
</Steps>
</Tab>
Expand Down
Loading