-
Notifications
You must be signed in to change notification settings - Fork 214
Simplify quickstart page for better user experience #2920
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.
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
Conversation
- 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
| 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 |
There was a problem hiding this comment.
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).
| 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`. |
There was a problem hiding this comment.
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.
| 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. |
There was a problem hiding this comment.
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.
| 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> |
There was a problem hiding this comment.
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.
Summary
Simplified the quickstart page to improve user experience and reduce cognitive load for new users.
Key improvements
Changes made
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.mdxto a shorter, action-focused guide and prioritizes the web editor path.Stepsfocused on the web editorTipand trims verbose local workflow instructionsWritten by Cursor Bugbot for commit bb65918. This will update automatically on new commits. Configure here.