Skip to content

Conversation

@mintlify-development
Copy link
Contributor

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

Summary

Simplified the quickstart page to improve user experience and reduce cognitive load for new users.

Key improvements

  • Reduced length by 50%: From 146 lines to 74 lines
  • Streamlined deployment: Converted verbose explanations to simple numbered steps
  • Removed complexity: Eliminated accordion section and complex tooltip explanations
  • Focused editing flow: Made web editor the primary path with CLI as an optional tip
  • More actionable language: Changed section headings and content to be more direct

Changes made

  • Simplified intro from verbose explanation to direct action-oriented statement
  • Converted deployment section to clear numbered steps
  • Removed optional accordion section about skipping GitHub connection
  • Replaced dual-tab editing flow with single web editor flow (CLI mentioned as tip)
  • Made "Next steps" section more concise
  • Reduced wordiness throughout while preserving all essential information

Result

New users can now get their documentation site live and make their first edit with significantly less cognitive overhead while retaining all necessary functionality.


Note

Condenses quickstart.mdx to a shorter, action-focused guide and prioritizes the web editor path.

  • Rewrites intro and deployment into concise numbered steps; surfaces live site URL and where to find it in the dashboard
  • Removes accordion, tooltips, and tabbed CLI/Web flows; replaces with a single "Make your first edit" section using Steps focused on the web editor
  • Moves CLI to an optional Tip and trims verbose local workflow instructions
  • Updates "Next steps" cards with shorter copy and order; keeps custom domain and CLI links

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

- Reduced page length from 146 to 74 lines  
- Streamlined deployment steps to simple numbered list
- Removed complex accordion section and tooltip
- Focused on web editor as primary editing path with CLI as option
- Made all sections more concise and action-oriented
Comment on lines +11 to +14
1. Go to [mintlify.com/start](https://mintlify.com/start)
2. Connect your GitHub account
3. Create or select a repository for your documentation
4. 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.

This step list is clearer if you call out the GitHub App authorization explicitly (it is the part that enables deployments).

Suggested change
1. Go to [mintlify.com/start](https://mintlify.com/start)
2. Connect your GitHub account
3. Create or select a repository for your documentation
4. Complete the onboarding process
1. Go to [mintlify.com/start](https://mintlify.com/start)
2. Connect your GitHub account
3. Create or select a repository for your documentation
4. Install the GitHub App and complete onboarding

4. Complete the onboarding process

When you connect your documentation repository to your Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
Your site is now live at `https://<your-project-name>.mintlify.app`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Depending on repo size / deploy queue, the first deploy can take a minute; this wording avoids implying it is instantaneous.

Suggested change
Your site is now live at `https://<your-project-name>.mintlify.app`.
Your site will be live at `https://<your-project-name>.mintlify.app` within a minute or two.

Click **Publish** in the top-right corner.
</Step>
<Step title="View your changes">
Refresh your documentation site to see your changes live.
Copy link
Contributor

Choose a reason for hiding this comment

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

Small expectation-setting: publishing triggers a deployment, so users may need to wait before the refresh shows changes.

Suggested change
Refresh your documentation site to see your changes live.
Wait for the deployment to finish (check the **Overview** page), then refresh your documentation site to see your changes live.

</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Work locally with advanced tools and commands.
</Card>
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: add a trailing newline at EOF to keep diffs/formatters happy.

@ethanpalm ethanpalm closed this Jan 28, 2026
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