Skip to content

Commit 8c25681

Browse files
Documentation edits made through Mintlify web editor
1 parent 0495a5a commit 8c25681

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

quickstart.mdx

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,31 @@ description: "Deploy your documentation in minutes"
44
icon: "rocket"
55
---
66

7-
This quickstart guide shows you how to set up and deploy your documentation site in minutes.
7+
# Quickstart Guide
88

9-
After you complete this guide, you will have a live documentation site ready to customize and expand.
9+
Deploy your documentation site in minutes with this step-by-step guide.
10+
11+
After completing this guide, you'll have a live documentation site ready to customize and expand.
1012

1113
<Info>
1214

13-
**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.
15+
**Prerequisites**: Before you begin, [create a Mintlify account](https://mintlify.com/start) and complete onboarding.
1416

1517
</Info>
1618

17-
## Getting Started
19+
## Set Up Your Documentation Site
1820

19-
After you complete the onboarding process, your documentation site will automatically deploy to a unique URL with this format:
21+
After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format:
2022

2123
```
2224
https://<your-project-name>.mintlify.app
2325
```
2426

25-
Find your URL on the Overview page of your [dashboard](https://dashboard.mintlify.com/).
27+
Find your URL on the Overview page of your [Mintlify dashboard](https://dashboard.mintlify.com/).
2628

2729
<Frame>
28-
<img src="/images/quickstart/mintlify-domain-light.png" alt="Mintlify Domain" className="block dark:hidden" />
29-
<img src="/images/quickstart/mintlify-domain-dark.png" alt="Mintlify Domain" className="hidden dark:block" />
30+
<img src="/images/quickstart/mintlify-domain-light.png" alt="Screenshot of Mintlify dashboard showing the unique project URL in light mode" className="block dark:hidden" />
31+
<img src="/images/quickstart/mintlify-domain-dark.png" alt="Screenshot of Mintlify dashboard showing the unique project URL in dark mode" className="hidden dark:block" />
3032
</Frame>
3133

3234
This URL becomes available immediately and updates when you make changes to your documentation. Use this URL for testing and sharing with your team during development.
@@ -35,27 +37,28 @@ This URL becomes available immediately and updates when you make changes to your
3537

3638
Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
3739

38-
Install the GitHub App by following the instructions from the onboarding checklist or from your dashboard.
40+
Install the GitHub App by following these steps:
3941

40-
1. Navigate to **Settings** in your Mintlify dashboard.
41-
2. Select **GitHub App** from the sidebar.
42-
3. Select **Install GitHub App**. This opens a new tab to the GitHub App installation page.
43-
4. Select the organization or user account where you want to install the app. Then select the repositories that you want to connect.
42+
1. Navigate to **Settings** in your Mintlify dashboard
43+
2. Select **GitHub App** from the sidebar
44+
3. Select **Install GitHub App** (opens a new tab to the GitHub App installation page)
45+
4. Select the organization or user account where you want to install the app
46+
5. Select the repositories you want to connect
4447

4548
<Frame>
46-
<img src="/images/quickstart/github-app-installation-light.png" alt="GitHub App Installation" className="block dark:hidden" />
47-
<img src="/images/quickstart/github-app-installation-dark.png" alt="GitHub App Installation" className="hidden dark:block" />
49+
<img src="/images/quickstart/github-app-installation-light.png" alt="Screenshot of GitHub App installation page showing repository selection in light mode" className="block dark:hidden" />
50+
<img src="/images/quickstart/github-app-installation-dark.png" alt="Screenshot of GitHub App installation page showing repository selection in dark mode" className="hidden dark:block" />
4851
</Frame>
4952

5053
<Info>
5154
Update the GitHub App permissions if you move your documentation to a different repository.
5255
</Info>
5356

54-
### Authorize your GitHub Account
57+
### Authorize Your GitHub Account
5558

56-
1. Navigate to **Settings** in your Mintlify dashboard.
57-
2. Select **My Profile** from the sidebar.
58-
3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page.
59+
1. Navigate to **Settings** in your Mintlify dashboard
60+
2. Select **My Profile** from the sidebar
61+
3. Select **Authorize GitHub account** (opens a new tab to the GitHub authorization page)
5962

6063
<Info>
6164
An admin for your GitHub organization may need to authorize your account depending on your organization settings.

0 commit comments

Comments
 (0)