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

Rewrites quickstart.mdx to a shorter, step-driven guide focused on the web editor.

  • Replaces multi-section, component-heavy content (AccordionGroup, Tabs, Frame, Tip, CLI steps) with concise numbered steps for deploy and first edit
  • Consolidates deployment into 3 steps and editing into 4 steps with a minimal MDX example
  • Removes screenshots and optional flows; prioritizes web editor over CLI
  • Trims “Next steps” to a single custom domain card

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
## View your deployed site

Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.
1. Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process
Copy link
Contributor

Choose a reason for hiding this comment

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

Add periods to the numbered list so it reads consistently.

Suggested change
1. Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process
1. Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process.
2. Connect your GitHub account and create or select a repository for your documentation.
3. Your site is now live at `https://<your-project-name>.mintlify.app`.

```bash npm
npm i -g mint
```
1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard
Copy link
Contributor

Choose a reason for hiding this comment

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

Fenced code blocks inside a numbered list usually need indentation, otherwise the list can break in some renderers.

Suggested change
1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard
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.

0 participants