-
Notifications
You must be signed in to change notification settings - Fork 214
Simplify quickstart page structure and reduce complexity #2912
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
Closed
+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
Contributor
- 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
Comment on lines
+19
to
+30
| 1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard | ||
| 2. Open `index.mdx` and update the description: | ||
|
|
||
|
|
||
| ```bash pnpm | ||
| pnpm add -g mint | ||
| ``` | ||
|
|
||
| </CodeGroup> | ||
|
|
||
| See [Install the CLI](/installation) for full details and troubleshooting. | ||
| </Step> | ||
| <Step title="Clone your repository"> | ||
| If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). | ||
| </Step> | ||
| <Step title="Edit a page"> | ||
| Open `index.mdx` in your preferred editor and update the description in the frontmatter: | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Introduction" | ||
| description: "Your custom description here" | ||
| --- | ||
| ``` | ||
| </Step> | ||
| <Step title="Preview locally"> | ||
| Run the following command from your documentation directory: | ||
|
|
||
| ```bash | ||
| mint dev | ||
| ``` | ||
|
|
||
| View your preview at `http://localhost:3000`. | ||
| </Step> | ||
| <Step title="Push your changes"> | ||
| Commit and push your changes to trigger a deployment: | ||
|
|
||
| ```bash | ||
| git add . | ||
| git commit -m "Update description" | ||
| git push | ||
| ``` | ||
|
|
||
| Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. | ||
| </Step> | ||
| </Steps> | ||
| </Tab> | ||
| <Tab title="Web editor"> | ||
| <Steps> | ||
| <Step title="Open the web editor"> | ||
| Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. | ||
| </Step> | ||
| <Step title="Edit a page"> | ||
| Open `index.mdx` and update the description in the frontmatter: | ||
| ```mdx | ||
| --- | ||
| title: "Introduction" | ||
| description: "Your custom description here" | ||
| --- | ||
| ``` | ||
|
|
||
| ```mdx | ||
| --- | ||
| title: "Introduction" | ||
| description: "Your custom description here" | ||
| --- | ||
| ``` | ||
| </Step> | ||
| <Step title="Publish"> | ||
| Click the **Publish** button in the top-right of the web editor toolbar. | ||
| </Step> | ||
| <Step title="View live"> | ||
| On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. | ||
| </Step> | ||
| </Steps> | ||
| </Tab> | ||
| </Tabs> | ||
| 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like the fenced code block got detached from step 2; indenting it keeps it nested under the list item so the numbering renders as intended.
Suggested change
| 1. Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard | |
| 2. Open `index.mdx` and update the description: | |
| ```bash pnpm | |
| pnpm add -g mint | |
| ``` | |
| </CodeGroup> | |
| See [Install the CLI](/installation) for full details and troubleshooting. | |
| </Step> | |
| <Step title="Clone your repository"> | |
| If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository). | |
| </Step> | |
| <Step title="Edit a page"> | |
| Open `index.mdx` in your preferred editor and update the description in the frontmatter: | |
| ```mdx | |
| --- | |
| title: "Introduction" | |
| description: "Your custom description here" | |
| --- | |
| ``` | |
| </Step> | |
| <Step title="Preview locally"> | |
| Run the following command from your documentation directory: | |
| ```bash | |
| mint dev | |
| ``` | |
| View your preview at `http://localhost:3000`. | |
| </Step> | |
| <Step title="Push your changes"> | |
| Commit and push your changes to trigger a deployment: | |
| ```bash | |
| git add . | |
| git commit -m "Update description" | |
| git push | |
| ``` | |
| Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard. | |
| </Step> | |
| </Steps> | |
| </Tab> | |
| <Tab title="Web editor"> | |
| <Steps> | |
| <Step title="Open the web editor"> | |
| Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard. | |
| </Step> | |
| <Step title="Edit a page"> | |
| Open `index.mdx` and update the description in the frontmatter: | |
| ```mdx | |
| --- | |
| title: "Introduction" | |
| description: "Your custom description here" | |
| --- | |
| ``` | |
| ```mdx | |
| --- | |
| title: "Introduction" | |
| description: "Your custom description here" | |
| --- | |
| ``` | |
| </Step> | |
| <Step title="Publish"> | |
| Click the **Publish** button in the top-right of the web editor toolbar. | |
| </Step> | |
| <Step title="View live"> | |
| On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live. | |
| </Step> | |
| </Steps> | |
| </Tab> | |
| </Tabs> | |
| 3. Click **Publish** to deploy your changes | |
| 4. Refresh your documentation site to see the update live | |
| 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" | |
| --- |
- Click Publish to deploy your changes
- 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
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
Simplifies
quickstart.mdxto a concise, step-by-step flow centered on the web editor.index.mdxfrontmatterWritten by Cursor Bugbot for commit a00c0d2. This will update automatically on new commits. Configure here.