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

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

Check warning on line 7 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L7

Avoid using 'will'.

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

Check warning on line 10 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L10

': B' should be in lowercase.
</Info>

## Getting started
Expand Down Expand Up @@ -36,11 +36,13 @@

Your site's URL is available immediately. Use this URL for testing and sharing with your team while you are setting up your docs site.

### Install the GitHub App
### Connect your GitHub repository

Mintlify provides a GitHub App that automates deployment when you push changes to your repository.
Mintlify integrates directly with GitHub to automatically deploy your documentation when you push changes to your repository. This Git-based workflow ensures your documentation stays in sync with your codebase and enables version control, collaboration, and review processes.

Install the GitHub App by following the instructions from the onboarding checklist or your dashboard.
#### Install the GitHub App

Check warning on line 43 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L43

'Install the GitHub App' should use sentence-style capitalization.

The Mintlify GitHub App monitors your repository for changes and triggers automatic deployments.

1. Navigate to **Settings** in your Mintlify dashboard.
2. Select **GitHub App** from the sidebar.
Expand All @@ -66,14 +68,14 @@
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.

Check warning on line 74 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L74

Avoid first-person pronouns such as 'My'.
3. Select **Authorize GitHub account**. This 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.

Check warning on line 78 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L78

Use 'administrator' instead of 'admin'.
</Info>

## Editing workflows
Expand All @@ -90,15 +92,15 @@

## Code-based workflow

The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code.
The code-based workflow integrates with your existing development environment and Git repositories. This workflow is best for technical teams who want to manage documentation alongside code using familiar Git-based version control.

### Install the CLI

Check warning on line 97 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L97

Use 'command-line tool' instead of 'CLI'.

<Info>
**Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v20.17.0 or higher through v24. LTS versions are preferred.

Check warning on line 100 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L100

': T' should be in lowercase.

Check warning on line 100 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L100

Use 'command-line tool' instead of 'CLI'.

Check warning on line 100 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L100

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

Check warning on line 100 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L100

In general, use active voice instead of passive voice ('are preferred').
</Info>

To work locally with your documentation, install the Command Line Interface (CLI), called [mint](https://www.npmjs.com/package/mint), by running this command in your terminal:

Check warning on line 103 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L103

Use parentheses judiciously.

Check warning on line 103 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L103

Use 'command-line tool' instead of 'CLI'.

<CodeGroup>

Expand Down Expand Up @@ -166,19 +168,29 @@

### Push the changes

When you are ready to publish your changes, push them to your repository.
When you are ready to publish your changes, commit and push them to your GitHub repository:

Check warning on line 171 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L171

Use the Oxford comma in 'When you are ready to publish your changes, commit and'.

```bash
git add .
git commit -m "Update introduction title"
git push origin main
```

Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).
Mintlify automatically detects the changes through the GitHub App, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).

After the deployment completes, your latest update will be available at `<your-project-name>.mintlify.app`.

Check warning on line 181 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L181

Avoid using 'will'.

<Tip>
Use Git branches and pull requests to review changes before merging to your main branch. Learn more about [working with branches](/guides/branches).
</Tip>

<Card title="Jump to adding a custom domain" icon="arrow-down" horizontal href="#adding-a-custom-domain">
Optionally, skip the web editor workflow and jump to adding a custom domain.
</Card>

## Web editor workflow

The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools.

Check warning on line 193 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L193

Use parentheses judiciously.

### Access the web editor

Expand All @@ -186,7 +198,7 @@
2. Select **Editor** on the left sidebar.

<Info>
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.

Check warning on line 201 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L201

Use 'haven't' instead of 'have not'.

Check warning on line 201 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L201

Avoid using 'will'.

Check warning on line 201 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L201

In general, use active voice instead of passive voice ('be prompted').
</Info>

<Frame>
Expand All @@ -205,11 +217,11 @@

### Edit the documentation

In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:

Check warning on line 220 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L220

Try to avoid using first-person plural like 'Let's'.

Find and select `index.mdx` in the file explorer.

Then, in the editor, update the title field to "Hello World".

Check warning on line 224 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L224

Commas and periods go inside quotation marks.

<Frame>
<img
Expand All @@ -233,13 +245,13 @@

### Publish your changes

When you're satisfied with your edits, select the **Publish** button in the top-right corner. Your changes are immediately deployed to your documentation site.
When you're satisfied with your edits, select the **Publish** button in the top-right corner. The web editor commits your changes to your GitHub repository and triggers an automatic deployment to your documentation site.

<Tip>
Use branches to preview and review changes through pull requests before deploying to your live site.
Use Git branches to preview and review changes through pull requests before deploying to your live site. The web editor supports creating and switching between branches.
</Tip>

For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor).

Check warning on line 254 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L254

Try to avoid using first-person plural like 'our'.

## Adding a custom domain

Expand All @@ -261,21 +273,21 @@
/>
</Frame>

Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider.

Check warning on line 276 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L276

Use parentheses judiciously.

<Table>
| Record Type | Name | Value | TTL |
| ----------- | ------------------- | -------------------- | ---- |
| CNAME | docs (or subdomain) | cname.vercel-dns.com | 3600 |

Check warning on line 281 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L281

Use parentheses judiciously.
</Table>

<Info>
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
</Info>

## Next steps

Check warning on line 288 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L288

'Next steps' should use sentence-style capitalization.

Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:

Check warning on line 290 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L290

Don't use exclamation points in text.

Check warning on line 290 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L290

In general, use active voice instead of passive voice ('are suggested').

<Card title="Configure your global settings" icon="settings" horizontal href="organize/settings">
Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
Expand Down Expand Up @@ -309,5 +321,5 @@
Deployment can take up to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.
</Accordion>
<Accordion title="Custom domain not connecting">
Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record.

Check warning on line 324 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L324

In general, use active voice instead of passive voice ('are set').
</Accordion>
Expand Down