Skip to content

Consolidate quickstart page by 55%#3127

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/consolidate-quickstart-55-percent-15232
Closed

Consolidate quickstart page by 55%#3127
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/consolidate-quickstart-55-percent-15232

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 5, 2026

Reduced quickstart content from ~1,100 to ~495 words while maintaining all essential deployment and editing steps. Removed redundant sections including "Before you begin", accordion content, images, and "Next steps" cards to create a more focused getting-started experience.

Files changed:

  • quickstart.mdx - Consolidated content by 55%

Note

Low Risk
Documentation-only changes that remove/condense onboarding content and steps; low risk beyond potentially omitting guidance users previously relied on.

Overview
Streamlines quickstart.mdx into a shorter, more direct “deploy + first edit” guide, removing the prior Before you begin section, optional GitHub-skip accordion, dashboard screenshots/frames, tips, and other redundant explanations.

Reworks the “Make your first change” section to lead with a new Web editor tab and condenses the CLI path (drops pnpm/CodeGroup, merges edit+preview instructions, and simplifies deployment language) while keeping the core steps to install, edit, preview, and deploy.

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

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.

<CodeGroup>
Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider making this a full sentence for consistency/readability.

Suggested change
Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.

<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:
<Step title="Edit and preview">
Clone your repository, open `index.mdx`, and update the description:
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor: adding a direct link here makes the “Clone your repository” step easier to find.

Suggested change
Clone your repository, open `index.mdx`, and update the description:
Clone your repository (see [/installation#clone-your-repository](/installation#clone-your-repository)), open `index.mdx`, and update the description:

```

View your preview at `http://localhost:3000`.
Preview locally with `mint dev` at `http://localhost:3000`.
Copy link
Contributor

Choose a reason for hiding this comment

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

mint dev can bind a different port if 3000 is taken; calling that out avoids confusion.

Suggested change
Preview locally with `mint dev` at `http://localhost:3000`.
Preview locally with `mint dev` (default: `http://localhost:3000`).

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