Skip to content

Quickstart guide updates#5634

Closed
dks333 wants to merge 1 commit intomainfrom
sam/remove-slash
Closed

Quickstart guide updates#5634
dks333 wants to merge 1 commit intomainfrom
sam/remove-slash

Conversation

@dks333
Copy link
Copy Markdown
Contributor

@dks333 dks333 commented May 1, 2026

Summary

This update refines the quickstart guide to improve clarity and user experience for new Mintlify users. It includes updated instructions for deploying a documentation site, making the first content change, and integrating AI coding tools.

Changes

  • Improved "Before you begin" section with clearer explanations of the docs-as-code approach.
  • Added a new tip for AI coding tool users, including a prompt for integrating Mintlify skill and MCP server.
  • Updated deployment instructions, including an accordion for skipping Git provider connection.
  • Revised "Make your first change" section with updated CLI instructions and a new tab for pnpm.
  • Added new screenshots for the Mintlify dashboard overview page.

Note

Low Risk
Low risk since it only updates documentation content, though the restructured Tabs/Steps markup could affect rendering/build if the new nesting is invalid.

Overview
Updates quickstart.mdx to add an AI-tooling tip (with SkillMcpPrompt), clarify the docs-as-code/repo workflow, and expand onboarding/deployment guidance including an option to skip Git-provider connection plus new dashboard Overview screenshots.

Restructures the “Make your first change” section, adjusting CLI install instructions (npm/pnpm) and removing the previously detailed web-editor walkthrough in favor of a simplified/placeholder tab layout.

Reviewed by Cursor Bugbot for commit 9dcc6a8. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 9dcc6a8. Configure here.

Comment thread quickstart.mdx
Open the **Introduction** page and update the description.

<Frame>
<img
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Tab components incorrectly nested inside Step element

High Severity

<Tab title="CLI"> and <Tab title="Web editor"> are nested inside the <Step title="Install the CLI"> element (which itself is inside the outer <Tab title="CLI">). This creates an invalid component hierarchy — Tab components aren't designed to be children of Step components. The entire "Make your first change" section structure is broken, likely causing rendering issues or a broken page layout.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 9dcc6a8. Configure here.

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