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

After you complete this guide, you'll have a live documentation site ready to customize and update.
Deploy a live documentation site and make your first change.

## Before you begin
## Choose your repository

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 headline="Repository" 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 can use your own Git repository or a Mintlify-hosted repository.

Choose your repository approach.
Mintlify uses a docs-as-code approach. Every page on your site has a corresponding file stored in your documentation <Tooltip headline="Repository" 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 can use your own Git repository or a Mintlify-hosted repository.

<CardGroup cols={2}>
<Card title="Mintlify-hosted" icon="cloud">
Mintlify creates a private GitHub repository connected to your Mintlify deployment.
Mintlify creates a private GitHub repository connected to your deployment.

Choose this option if:
- You will only work in the web editor and don't want to use Git locally.
- You want to get started quickly without connecting a repository.
- You want Mintlify to manage your documentation repository for you.
**Choose this if:**
- You only work in the web editor
- You want to get started quickly
- You want Mintlify to manage your repository
</Card>

<Card title="Your own repository" icon="github">
Connect your own Git repository to your Mintlify deployment.
Connect your own Git repository to your deployment.

Choose this option if:
- You will work locally and want to sync to your remote repository.
- You already have a repository for your documentation.
- You want your documentation to be under your own GitHub organization.
**Choose this if:**
- You work locally and sync to your remote repository
- You already have a documentation repository
- You want documentation under your GitHub organization
</Card>
</CardGroup>

<Tip>
Not sure which to choose? Start with **Mintlify-hosted**. You can migrate to your own repository anytime if it better suits your needs.
Start with **Mintlify-hosted**. You can migrate to your own repository anytime.
</Tip>

## Deploy your documentation site
## Deploy your site

<Tabs>
<Tab title="Mintlify-hosted">
Expand All @@ -45,13 +43,13 @@
Go to [mintlify.com/start](https://mintlify.com/start) and create your account.
</Step>
<Step title="Skip GitHub connection">
When prompted to connect GitHub, click **Skip** to use a Mintlify-hosted repository.
Click **Skip** when prompted to connect GitHub.
</Step>
<Step title="Complete onboarding">
Follow the onboarding prompts to set up your documentation. Mintlify automatically creates a private repository in the `mintlify-community` organization and configures the GitHub app for you.
Follow the onboarding prompts. Mintlify creates a private repository in the `mintlify-community` organization and configures the GitHub app.
</Step>
<Step title="Your site is deployed">

Check warning on line 51 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L51

In general, use active voice instead of passive voice ('is deployed').
Your documentation is immediately deployed and accessible at your `.mintlify.app` URL.
Your documentation is deployed at your `.mintlify.app` URL.
</Step>
</Steps>
</Tab>
Expand All @@ -62,33 +60,33 @@
Go to [mintlify.com/start](https://mintlify.com/start) and create your account.
</Step>
<Step title="Connect GitHub">
When prompted, log in to your GitHub account and authenticate.
Log in to your GitHub account and authenticate.
</Step>
<Step title="Complete onboarding">
Follow the remaining onboarding prompts to create a repository and continue to your dashboard.
Follow the onboarding prompts to create a repository.
</Step>
<Step title="Install the GitHub App">
Install the Mintlify [GitHub App](https://dashboard.mintlify.com/api/github/install-app) to enable automatic deployments. This allows Mintlify to sync with your repository and deploy changes automatically when you push.
Install the [GitHub App](https://dashboard.mintlify.com/api/github/install-app) to enable automatic deployments.
</Step>
<Step title="Optional: Select a repository">
If you want to use a different repository than the one created during onboarding for your documentation, select it on the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page of your dashboard. Your documentation repository must have a valid `docs.json` file to deploy.
To use a different repository, select it on the [Git settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page. Your repository must have a valid `docs.json` file.
</Step>
<Step title="Your site is deployed">

Check warning on line 74 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L74

In general, use active voice instead of passive voice ('is deployed').
Your documentation is deployed and accessible at your `.mintlify.app` URL. Future changes pushed to your repository will automatically trigger new deployments.
Your documentation is deployed at your `.mintlify.app` URL. Future changes automatically trigger new deployments.
</Step>
</Steps>

<Info>
To learn more about the GitHub App and its permissions, see [GitHub](/deploy/github).
Learn more about the GitHub App at [GitHub](/deploy/github).
</Info>
</Tab>
</Tabs>

## View your deployed site
## View your 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 87 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L87

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 @@ -105,17 +103,17 @@
</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

<Steps>
<Step title="Open the web editor">
Navigate to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
Go to the [web editor](https://dashboard.mintlify.com/editor) in your dashboard.
</Step>
<Step title="Edit a page">
Open `index.mdx` and update the description in the frontmatter:
Open `index.mdx` and update the description:

```mdx
---
Expand All @@ -125,14 +123,14 @@
```
</Step>
<Step title="Publish">
Click the **Publish** button in the top-right of the web editor toolbar.
Click **Publish** in the top-right 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. Refresh your site to see your changes.
</Step>
</Steps>

## Next steps

Check warning on line 133 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L133

'Next steps' should use sentence-style capitalization.

<CardGroup cols={3}>
<Card title="Learn about the web editor" icon="mouse-pointer-2" href="/editor">
Expand All @@ -140,7 +138,7 @@
</Card>

<Card title="Set up local development" icon="terminal" href="/installation">
Use the CLI to preview your documentation locally as you write and edit.

Check warning on line 141 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L141

Use 'command-line tool' instead of 'CLI'.
</Card>

<Card title="Add a custom domain" icon="globe" href="/customize/custom-domain">
Expand Down