Skip to content

Update Quickstart page for improved style and accessibility #786

New issue

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

#

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

Already on GitHub? # to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update Quickstart page for improved style and accessibility #786

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
41 changes: 22 additions & 19 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,31 @@ description: "Deploy your documentation in minutes"
icon: "rocket"
---

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

After you complete this guide, you will have a live documentation site ready to customize and expand.
Deploy your documentation site in minutes with this step-by-step guide.

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

<Info>

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

</Info>

## Getting Started
## Set Up Your Documentation Site

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

```
https://<your-project-name>.mintlify.app
```

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

<Frame>
<img src="/images/quickstart/mintlify-domain-light.png" alt="Mintlify Domain" className="block dark:hidden" />
<img src="/images/quickstart/mintlify-domain-dark.png" alt="Mintlify Domain" className="hidden dark:block" />
<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" />
<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" />
</Frame>

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.
Expand All @@ -35,27 +37,28 @@ This URL becomes available immediately and updates when you make changes to your

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

Install the GitHub App by following the instructions from the onboarding checklist or from your dashboard.
Install the GitHub App by following these steps:

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

<Frame>
<img src="/images/quickstart/github-app-installation-light.png" alt="GitHub App Installation" className="block dark:hidden" />
<img src="/images/quickstart/github-app-installation-dark.png" alt="GitHub App Installation" className="hidden dark:block" />
<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" />
<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" />
</Frame>

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

### Authorize your GitHub Account
### Authorize Your GitHub Account

1. Navigate to **Settings** in your Mintlify dashboard.
2. Select **My Profile** from the sidebar.
3. Select **Authorize GitHub account**. This opens a new tab to the GitHub authorization page.
1. Navigate to **Settings** in your Mintlify dashboard
2. Select **My Profile** from the sidebar
3. Select **Authorize GitHub account** (opens a new tab to the GitHub authorization page)

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