Skip to content

Add hello world to quickstart #3050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify-development wants to merge 1 commit into from
Closed

Add hello world to quickstart #3050

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 2 additions & 0 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

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

Hello world!

Check warning on line 9 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L9 

Don't use exclamation points in text.
Copy link

@cursor cursor bot Feb 2, 2026

Choose a reason for hiding this comment

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

Test placeholder text accidentally committed to documentation

Medium Severity

The text Hello world! appears to be test content that was accidentally committed to the production quickstart documentation. It sits without context between the introduction and "Before you begin" section, disrupting the professional flow. Notably, "Hello world!" is used later in this same document as an example of what users write when following the tutorial, suggesting someone tested the editing workflow and forgot to remove their test change.

Fix in Cursor Fix in Web


## Before you begin

Mintlify uses a docs-as-code approach to manage your documentation. Every page on your site has a corresponding file stored in your documentation <Tooltip tip="Your documentation's source code where all files and their history are stored. The web editor connects to your documentation repository to access and modify content, or you can edit files locally in your preferred IDE.">repository</Tooltip>.
Expand All @@ -16,7 +18,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 21 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L21 

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

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
Expand Down Expand Up @@ -56,7 +58,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 61 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L61 

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

<CodeGroup>

Expand Down Expand Up @@ -138,7 +140,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 143 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L143 

Avoid using 'will'.
</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
Expand Down
Loading