Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Quickstart"
title: "hi Quickstart"
Copy link

Choose a reason for hiding this comment

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

Accidental "hi" prefix in page title

Medium Severity

The page title was changed from "Quickstart" to "hi Quickstart", which looks like a casual test or debug edit that wasn't meant for production. This will be visible to end users as the page heading and likely in navigation, browser tabs, and search results.

Fix in Cursor Fix in Web

description: "Deploy your documentation site and make your first change."
keywords: ["quickstart","deploy","get started","first steps","tutorial","setup","onboarding"]
---
Expand Down Expand Up @@ -32,7 +32,7 @@

Go to [mintlify.com/start](https://mintlify.com/start) and complete the onboarding process. During onboarding, you'll connect your GitHub account, create or select a repository for your documentation, and install the GitHub App to enable automatic deployments.

After onboarding, your documentation site is deployed and accessible at your `.mintlify.app` URL.

Check warning on line 35 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L35

In general, use active voice instead of passive voice ('is deployed').

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
Expand Down Expand Up @@ -72,7 +72,7 @@
<Tab title="CLI">
<Steps>
<Step title="Install the CLI">
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher. Use an LTS version for stability.

Check warning on line 75 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L75

Spell out 'LTS', if it's unfamiliar to the audience.

<CodeGroup>

Expand Down Expand Up @@ -159,7 +159,7 @@
## Next steps

<Card title="Use the web editor" icon="mouse-pointer-2" horizontal href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.

Check warning on line 162 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L162

Avoid using 'will'.
</Card>

<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation">
Expand Down
Loading