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
2 changes: 2 additions & 0 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@
icon: "rocket"
---

sup

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

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

Check warning on line 11 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L11

Avoid using 'will'.

<Info>

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

Check warning on line 15 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L15

': B' should be in lowercase.

</Info>

Expand All @@ -31,7 +33,7 @@

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

Check warning on line 36 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L36

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

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

Expand All @@ -55,11 +57,11 @@
### Authorize your GitHub account

1. Navigate to **Settings** in your Mintlify dashboard.
2. Select **My Profile** from the sidebar.

Check warning on line 60 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L60

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 64 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L64

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

## Editing workflows
Expand All @@ -78,9 +80,9 @@

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.

### Install the CLI

Check warning on line 83 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L83

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

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 85 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L85

Use parentheses judiciously.

Check warning on line 85 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L85

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

<CodeGroup>
```bash npm
Expand Down Expand Up @@ -127,7 +129,7 @@
mint dev
```

Your preview will be available at `localhost:3000`.

Check warning on line 132 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L132

Avoid using 'will'.

<Frame>
<img src="/images/quickstart/mintlify-dev-light.png" alt="Mintlify Dev" className="block dark:hidden" />
Expand All @@ -140,7 +142,7 @@

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).

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

Check warning on line 145 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L145

Avoid using 'will'.

<Card title="Jump to adding a custom domain" icon="arrow-down" href="#adding-a-custom-domain" horizontal>
Optionally, skip the web editor workflow and jump to adding a custom domain.
Expand All @@ -148,7 +150,7 @@

## 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 153 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L153

Use parentheses judiciously.

### Access the web editor

Expand All @@ -156,7 +158,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 161 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L161

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

Check warning on line 161 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L161

Avoid using 'will'.

Check warning on line 161 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L161

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

<Frame>
Expand All @@ -166,11 +168,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 171 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L171

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 175 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L175

Commas and periods go inside quotation marks.

<Frame>
<img alt="Editing in Web Editor" src="/images/quickstart/web-editor-editing-light.png" className="block dark:hidden" />
Expand All @@ -189,7 +191,7 @@
Use branches to preview and review changes through pull requests before deploying to your live site.
</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/getting-started).

Check warning on line 194 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L194

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

## Adding a custom domain

Expand All @@ -202,21 +204,21 @@
<img src="/images/quickstart/custom-domain-dark.png" alt="Custom Domain" className="hidden dark:block" />
</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 207 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L207

Use parentheses judiciously.

<Table>
| Record Type | Name | Value | TTL |
|-------------|------|-------|-----|
| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |

Check warning on line 212 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L212

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 219 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L219

'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 221 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L221

Don't use exclamation points in text.

Check warning on line 221 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L221

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

<Card title="Configure your global settings" icon="settings" href="settings" horizontal>
Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
Expand Down Expand Up @@ -246,6 +248,6 @@
Deployment can take upwards 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 251 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L251

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