Simplify quickstart page structure and reduce complexity #2917
+15
−125
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
- 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
![tembo[bot]](https://avatars.githubusercontent.com/in/1223475?s=60&v=4){kind=small}
Comment on lines
+11
to
+13
| 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` |
Contributor
There was a problem hiding this comment.
Consider adding terminal punctuation and softening the timing claim (initial deploy can take a bit).
Suggested change
| 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` | |
| 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. When the initial deploy finishes, your site will be live at `https://<your-project-name>.mintlify.app`. |
Comment on lines
+19
to
+20
| 1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard | ||
| 2. Open `index.mdx` and update the description: |
Contributor
There was a problem hiding this comment.
Minor wording tweak to be a bit more specific about the frontmatter field you're editing.
Suggested change
| 1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard | |
| 2. Open `index.mdx` and update the description: | |
| 1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. | |
| 2. Open `index.mdx` and update the `description` value: |
Comment on lines
+29
to
+30
| 3. Click **Publish** to deploy your changes | ||
| 4. Refresh your documentation site to see the update live |
Contributor
There was a problem hiding this comment.
Adding a quick fallback helps if the deploy is still in progress after publishing.
Suggested change
| 3. Click **Publish** to deploy your changes | |
| 4. Refresh your documentation site to see the update live | |
| 3. Click **Publish** to deploy your changes. | |
| 4. Refresh your documentation site to see the update live. If you don't see it yet, check **Overview** for deploy status. |
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
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
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
Note
Streamlines the
quickstart.mdxto a minimal, step-by-step guide centered on the web editor.Written by Cursor Bugbot for commit a00c0d2. This will update automatically on new commits. Configure here.