Simplify quickstart page for better user experience #2919
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Removed complex 'Before you begin' section - Streamlined deployment to 4 clear steps - Condensed 'Make your first change' from detailed instructions to essential actions - Made web editor the recommended path for new users - Removed optional accordion that added complexity - Focus on getting users to success quickly rather than explaining concepts upfront
![tembo[bot]](https://avatars.githubusercontent.com/in/1223475?s=60&v=4){kind=small}
| className="hidden dark:block" | ||
| /> | ||
| </Frame> | ||
| Your documentation site is now live at `https://<your-project-name>.mintlify.app`. |
Contributor
There was a problem hiding this comment.
Minor wording nit: this reads as instantaneous, but initial deploy can take a bit. Future tense here might be less confusing.
Suggested change
| Your documentation site is now live at `https://<your-project-name>.mintlify.app`. | |
| After onboarding, your documentation site will be live at `https://<your-project-name>.mintlify.app`. |
| <Tab title="Local development"> | ||
| <Steps> | ||
| <Step title="Install the CLI"> | ||
| ```bash |
Contributor
There was a problem hiding this comment.
Might be worth keeping the Node.js prereq here so local users don’t hit a confusing install error.
Suggested change
| ```bash | |
| <Step title="Install the CLI"> | |
| The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher (LTS recommended). | |
| ```bash | |
| npm i -g mint | |
| ``` | |
| </Step> |
|
|
||
| ```bash | ||
| mint dev | ||
| ``` |
Contributor
There was a problem hiding this comment.
Small UX win: add a quick “where do I see it?” verification after mint dev (and keep it flexible if the port changes).
Suggested change
| ``` | |
| <Step title="Clone and edit"> | |
| Clone your repository, edit `index.mdx`, then preview locally: | |
| ```bash | |
| mint dev | |
| ``` | |
| Open the URL printed in your terminal (usually `http://localhost:3000`). | |
| </Step> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR simplifies the quickstart page to reduce cognitive overhead and get users to success faster.
Changes made
Before and after
Before: 146 lines with detailed explanations, complex concepts, and multiple optional paths
After: 84 lines focused on the essential happy path to success
Rationale
The original quickstart tried to explain concepts upfront and cover many edge cases, which could overwhelm users who just want to get started quickly. This simplified version focuses on getting users to their first success moment as fast as possible, while keeping links to more detailed guides available when they need them.
Users can always dive deeper into CLI setup, repository concepts, and advanced options after they've had their initial success.
Note
Streamlines
quickstart.mdxto focus on a concise happy path and faster first success.Tipindex.mdxand publishmint dev), and deploy commandsweb editor,CLI commands, andcustom domainWritten by Cursor Bugbot for commit 112956e. This will update automatically on new commits. Configure here.