Skip to content

Conversation

@mintlify-development
Copy link
Contributor

@mintlify-development mintlify-development bot commented Jan 27, 2026

Summary

Streamlined the quickstart page to reduce cognitive load and get users to their first successful edit faster. The page went from 145 lines to 36 lines (75% reduction) while maintaining all essential functionality.

Changes made

  • Removed conceptual "Before you begin" section - Eliminated docs-as-code explanation that slowed down the getting started flow
  • Streamlined deployment section - Consolidated deployment and site viewing into 3 simple numbered steps
  • Focused on web editor only - Removed CLI/web editor tabs to eliminate choice paralysis and setup complexity
  • Simplified editing process - Reduced from 5 detailed steps to 4 simple numbered steps
  • Focused next steps - Cut from 3 next step cards down to 1 most important action (custom domain)

Rationale

The original quickstart had multiple sections and options that could overwhelm new users. This streamlined version follows the Mintlify principle of "just enough docs to solve users' needs and get them back to the product quickly."

Test plan

  • Verified all links are functional
  • Confirmed frontmatter is properly formatted
  • Ensured code examples are valid MDX
  • Maintained consistent voice and formatting with existing docs

Note

Simplifies quickstart.mdx to a concise, step-by-step flow centered on the web editor.

  • Replaces multi-section/tabs layout with two numbered flows: deploy (3 steps) and first change (4 steps) via web editor
  • Removes CLI path, accordions, tabs, images, and tip content to reduce complexity
  • Adds a minimal MDX example for updating index.mdx frontmatter
  • Narrows “Next steps” to a single custom domain action

Written by Cursor Bugbot for commit a00c0d2. This will update automatically on new commits. Configure here.

- Remove conceptual "Before you begin" section
- Streamline deployment section from detailed explanation to 3 simple steps
- Focus on web editor only, remove CLI tab option
- Reduce editing steps from 5 detailed steps to 4 simple numbered steps
- Remove 2 of 3 next steps cards to focus on most important action
- Page length reduced from ~145 lines to ~36 lines
Comment on lines +19 to +30
1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard
2. Open `index.mdx` and update the description:


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

</CodeGroup>

See [Install the CLI](/installation) 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](/installation#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 `index.mdx` and update the description in the frontmatter:
```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```

```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
</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.
</Step>
</Steps>
</Tab>
</Tabs>
3. Click **Publish** to deploy your changes
4. Refresh your documentation site to see the update live
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like the fenced code block got detached from step 2; indenting it keeps it nested under the list item so the numbering renders as intended.

Suggested change
1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard
2. Open `index.mdx` and update the description:
```bash pnpm
pnpm add -g mint
```
</CodeGroup>
See [Install the CLI](/installation) 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](/installation#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 `index.mdx` and update the description in the frontmatter:
```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
```mdx
---
title: "Introduction"
description: "Your custom description here"
---
```
</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.
</Step>
</Steps>
</Tab>
</Tabs>
3. Click **Publish** to deploy your changes
4. Refresh your documentation site to see the update live
1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard
2. Open `index.mdx` and update the `description` in the frontmatter:
```mdx
---
title: "Introduction"
description: "Your custom description here"
---
  1. Click Publish to deploy your changes
  2. Refresh your documentation site to see the update live

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant