Rewrite Quickstart page with richer MDX structure#5608
Rewrite Quickstart page with richer MDX structure#5608mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Mintlify-Source: dashboard-editor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit a766137. Configure here.
| Use your own domain for your documentation site. | ||
| </Card> No newline at end of file | ||
| <Card title="Customize your site" icon="paintbrush" href="/customize/overview"> | ||
| Configure branding, navigation, colors, and page layouts. |
There was a problem hiding this comment.
Broken link to nonexistent customize/overview page
High Severity
The newly added "Customize your site" card links to /customize/overview, but no customize/overview.mdx file exists in the repository. The customize/ directory only contains custom-404-page.mdx, custom-domain.mdx, custom-scripts.mdx, fonts.mdx, react-components.mdx, and themes.mdx. There's also no matching entry in docs.json navigation or redirects.json. This will result in a 404 for users clicking the card.
Reviewed by Cursor Bugbot for commit a766137. Configure here.
| </Tip> | ||
|
|
||
| Then add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md" actions={["copy", "cursor"]}> | ||
| <Prompt description="Install the Mintlify skill to get context on Mintlify project structure, components, and documentation best practices:\\n\\nnpx skills add https://mintlify.com/docs\\n\\nThen add the Mintlify MCP server for access to documentation search. Follow the setup instructions at https://www.mintlify.com/docs/ai/model-context-protocol.md" actions={["copy", "cursor"]}> |
There was a problem hiding this comment.
Escaped newlines render as literal backslash-n text
Medium Severity
The Prompt component's description prop uses \\n\\n to represent newlines, but in JSX string attributes \\n produces a literal backslash followed by the letter 'n' — not a newline character. The prompt card will display raw \n text between sentences instead of line breaks. The original used actual multi-line attribute values which preserved real newlines.
Reviewed by Cursor Bugbot for commit a766137. Configure here.
Full rewrite of the Quickstart page:
Mintlify
0 threads from 0 users in Mintlify
Note
Low Risk
Low risk documentation-only changes that reorganize MDX components and copy without affecting runtime logic.
Overview
Reworks the
Quickstartdocs page to be more structured and scannable: adds a new "How Mintlify works" section with upfront workflow selection viaCardGroup, and converts the deploy flow into a two-stepStepssequence (including the optional Git-provider accordion).Reorganizes "Make your first change" into
Tabswith the Web editor flow presented first, and tightens/clarifies copy across both Web editor and CLI instructions.Expands Next steps into a 2-column
CardGroupwith four cards (adds a new link to site customization) and standardizes metadata formatting (e.g.,keywords).Reviewed by Cursor Bugbot for commit a766137. Bugbot is set up for automated code reviews on this repo. Configure here.