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
34 changes: 17 additions & 17 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,33 @@
keywords: ["quickstart", "deploy", "get started", "first steps", "tutorial", "setup", "onboarding"]
---

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

## 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>.
Mintlify uses a docs-as-code approach. Each page has a corresponding file 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.
Connect your repository to your Mintlify deployment to work locally or in the web editor and sync changes to your remote repository.

## 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.
Go to [mintlify.com/start](https://mintlify.com/start) and complete onboarding. Connect your GitHub account, create or select a repository, and install the GitHub App to enable automatic deployments.

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

<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.
Skip the GitHub connection to get started quickly. Mintlify creates a private repository and configures the GitHub App automatically.

This lets you use the web editor immediately and migrate to your own repository later.
Use the web editor immediately and migrate to your own repository later.
</Accordion>
</AccordionGroup>

## View your deployed site

Your documentation site is now deployed at `https://<your-project-name>.mintlify.app`.
Your site is deployed at `https://<your-project-name>.mintlify.app`.

Check warning on line 31 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L31

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

Find your exact URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).
Find your URL on the **Overview** page of your [dashboard](https://dashboard.mintlify.com/).

<Frame>
<img
Expand All @@ -47,7 +47,7 @@
</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).
Use this URL for testing and sharing with your team. Add a [custom domain](/customize/custom-domain) before sharing with users.
</Tip>

## Make your first change
Expand All @@ -56,7 +56,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.
The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.

<CodeGroup>

Expand All @@ -71,10 +71,10 @@

</CodeGroup>

See [Install the CLI](/installation) for full details and troubleshooting.
See [Install the CLI](/installation) for details and troubleshooting.
</Step>
<Step title="Clone your repository">
If you haven't already cloned your repository locally, follow the instructions in [Clone your repository](/installation#clone-your-repository).
Follow the instructions in [Clone your repository](/installation#clone-your-repository).
</Step>
<Step title="Edit a page">
Open `index.mdx` in your preferred editor and update the description in the frontmatter:
Expand All @@ -87,7 +87,7 @@
```
</Step>
<Step title="Preview locally">
Run the following command from your documentation directory:
Run from your documentation directory:

```bash
mint dev
Expand All @@ -96,15 +96,15 @@
View your preview at `http://localhost:3000`.
</Step>
<Step title="Push your changes">
Commit and push your changes to trigger a deployment:
Commit and push to trigger a deployment:

```bash
git add .
git commit -m "Update description"
git push
```

Mintlify automatically deploys your changes. View your deployment status on the [Overview](https://dashboard.mintlify.com/) page of your dashboard.
Mintlify automatically deploys your changes. View deployment status on the [Overview](https://dashboard.mintlify.com/) page.
</Step>
</Steps>
</Tab>
Expand All @@ -129,7 +129,7 @@
Click the **Publish** button in the top-right of the web editor toolbar.
</Step>
<Step title="View live">
On the [Overview](https://dashboard.mintlify.com/) page of your dashboard, you can see your site's deployment status. When it finishes deploying, refresh your documentation site to see your changes live.
Check deployment status on the [Overview](https://dashboard.mintlify.com/) page. When deployment finishes, refresh your site to see changes live.
</Step>
</Steps>
</Tab>
Expand All @@ -138,7 +138,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 141 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L141

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