Skip to content

Quickstart guide updates#5809

Closed
dks333 wants to merge 1 commit into
mainfrom
sam/test
Closed

Quickstart guide updates#5809
dks333 wants to merge 1 commit into
mainfrom
sam/test

Conversation

@dks333
Copy link
Copy Markdown
Contributor

@dks333 dks333 commented May 14, 2026

Summary

This update to the quickstart guide streamlines the onboarding process for new users, focusing on deploying a documentation site and making initial content changes. It clarifies the use of the web editor versus local development and provides updated instructions for both.

Changes

  • Revised introduction to emphasize a live documentation site and customization
  • Added a new "Before you begin" section explaining Mintlify's docs-as-code approach
  • Included a prompt for AI coding tools to improve documentation updates
  • Updated "Deploy your documentation site" with a new accordion for skipping Git provider connection
  • Refined "Make your first change" with separate tabs for CLI and web editor instructions
  • Updated CLI instructions to reflect current best practices for installation, cloning, editing, previewing, and pushing changes
  • Updated web editor instructions for clarity

Note

Low Risk
Low risk since it only changes documentation content, but it introduces a likely typo (update.asd) and leaves the pnpm install code block empty which could confuse readers.

Overview
Updates quickstart.mdx by modifying the opening sentence (appending asd) and removing the actual pnpm add -g mint command from the CLI install CodeGroup, leaving an empty pnpm snippet.

Reviewed by Cursor Bugbot for commit cf68dd9. 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 cf68dd9. Configure here.

Comment thread quickstart.mdx
import SkillMcpPrompt from "/snippets/skill-mcp-prompt.mdx";

After you complete this guide, you'll have a live documentation site ready to customize and update.
After you complete this guide, you'll have a live documentation site ready to customize and update.asd
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Accidentally typed characters appended to sentence

Medium Severity

The string asd is appended to the end of the introductory sentence. This appears to be accidental keystrokes that were committed to a user-facing documentation page, which will be visible to all readers of the quickstart guide.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit cf68dd9. 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