Skip to content
Open
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
63 changes: 40 additions & 23 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,29 @@

## 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>.
You'll need a GitHub account to deploy your documentation site. Mintlify uses a docs-as-code approach where 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>.

When you connect your documentation repository to your Mintlify deployment, you can work on your documentation locally or in the web editor and sync any changes to your remote repository.
Your documentation repository connects to your Mintlify deployment, allowing you to work locally or in the web editor and sync changes automatically.

## Deploy your documentation site

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.
<Steps>
<Step title="Start onboarding">
Go to [mintlify.com/start](https://mintlify.com/start) to begin the onboarding process.
</Step>
<Step title="Connect GitHub">
Connect your GitHub account and create or select a repository for your documentation.
</Step>
<Step title="Install GitHub App">
Install the Mintlify GitHub App to enable automatic deployments when you push changes.
</Step>
</Steps>

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

Check warning on line 29 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L29

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

<AccordionGroup>
<Accordion title="Optional: Skip connecting GitHub during onboarding">
If you want to get started quickly without connecting your own repository, you can skip the GitHub connection during onboarding. Mintlify creates a private repository in a private organization and automatically configures the GitHub App for you.

This lets you use the web editor immediately and migrate to your own repository later.
</Accordion>
</AccordionGroup>
<Tip>
Want to get started quickly? You can skip connecting your own repository during onboarding. Mintlify will create a private repository for you, letting you use the web editor immediately and migrate to your own repository later.

Check warning on line 32 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L32

Avoid using 'will'.
</Tip>

## View your deployed site

Expand All @@ -46,9 +52,9 @@
/>
</Frame>

<Tip>
Your site is ready to view immediately. Use this URL for testing and sharing with your team. Before sharing with your users, you may want to add a [custom domain](/customize/custom-domain).
</Tip>
<Note>
Your site is live and ready to view. Use this URL for testing and sharing with your team. Add a [custom domain](/customize/custom-domain) before sharing with users.
</Note>

## Make your first change

Expand All @@ -56,7 +62,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 65 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L65

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

<CodeGroup>

Expand Down Expand Up @@ -137,12 +143,23 @@

## 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.
</Card>
<Card title="Explore CLI commands" icon="terminal" horizontal href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
</Card>
<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
<CardGroup cols={2}>
<Card title="Use the web editor" icon="mouse-pointer-2" href="/editor/index">
Edit documentation in your browser and preview how your pages will look when published.

Check warning on line 148 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L148

Avoid using 'will'.
</Card>
<Card title="Explore CLI commands" icon="terminal" href="/installation#additional-commands">
Find broken links, check accessibility, validate OpenAPI specs, and more.
</Card>
<Card title="Add a custom domain" icon="globe" href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
<Card title="Customize your theme" icon="palette" href="/customize/themes">
Configure colors, fonts, and branding to match your product.
</Card>
<Card title="Organize your navigation" icon="map" href="/organize/navigation">
Structure your documentation with groups, tabs, and sections.
</Card>
<Card title="Add API documentation" icon="file-json" href="/api-playground/overview">
Auto-generate interactive API reference from your OpenAPI spec.
</Card>
</CardGroup>
Loading