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
42 changes: 34 additions & 8 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,7 +36,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 39 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L39

'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 Down Expand Up @@ -69,11 +69,11 @@
### Authorize your GitHub account

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

Check warning on line 72 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L72

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L76

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

## Editing workflows
Expand All @@ -92,13 +92,13 @@

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L95

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L98

': T' should be in lowercase.

Check warning on line 98 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L98

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

Check warning on line 98 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L98

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

Check warning on line 98 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L98

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L101

Use parentheses judiciously.

Check warning on line 101 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L101

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

<CodeGroup>

Expand Down Expand Up @@ -170,7 +170,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 173 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L173

Avoid using 'will'.

<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.
Expand All @@ -178,7 +178,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 181 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L181

Use parentheses judiciously.

### Access the web editor

Expand All @@ -186,7 +186,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 189 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L189

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

Check warning on line 189 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L189

Avoid using 'will'.

Check warning on line 189 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L189

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

<Frame>
Expand All @@ -205,11 +205,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 208 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L208

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L212

Commas and periods go inside quotation marks.

<Frame>
<img
Expand Down Expand Up @@ -239,13 +239,17 @@
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).

Check warning on line 242 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L242

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

## Adding a custom domain

While your `<your-project-name>.mintlify.app` subdomain works well for testing and development, most teams prefer using a custom domain for production documentation.

To add a custom domain, navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
### Add your domain in the dashboard

1. Navigate to the [Custom domain setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.
2. Enter your domain name (for example, `docs.yourcompany.com`).

Check warning on line 251 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L251

Use parentheses judiciously.
3. Click **Add domain**.

<Frame>
<img
Expand All @@ -261,21 +265,43 @@
/>
</Frame>

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

On your domain provider's website, navigate to your domain's DNS settings and create a new CNAME record:

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

Check warning on line 275 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L275

Use parentheses judiciously.
</Table>

<Info>
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
</Info>
<Tip>
Each domain provider has different ways to add DNS records. Refer to your provider's documentation for specific instructions.
</Tip>

### Wait for DNS propagation and TLS provisioning

Check warning on line 282 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L282

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

DNS changes typically take 1-24 hours to propagate globally, though it can take up to 48 hours in some cases. You can verify your DNS configuration using [DNSChecker](https://dnschecker.org).

Once your DNS records propagate, Mintlify automatically provisions a free SSL/TLS certificate for your domain. Your site is first accessible via HTTP, then HTTPS becomes available after certificate provisioning completes.

Check warning on line 286 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L286

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

<AccordionGroup>
<Accordion title="Cloudflare users">
If Cloudflare is your DNS provider, enable "Full (strict)" mode for SSL/TLS encryption. Also disable "Always Use HTTPS" in Edge Certificates settings to allow certificate validation.

Check warning on line 290 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L290

Use parentheses judiciously.

Check warning on line 290 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L290

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

Check warning on line 290 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L290

Use 'turn off' or 'off' instead of 'disable'.
</Accordion>
<Accordion title="Vercel users">
If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain.
</Accordion>
<Accordion title="Using CAA records">

Check warning on line 295 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L295

Spell out 'CAA', if it's unfamiliar to the audience.
If your domain uses CAA (Certification Authority Authorization) records, add `0 issue "letsencrypt.org"` to authorize certificate issuance.

Check warning on line 296 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L296

Use parentheses judiciously.
</Accordion>
</AccordionGroup>

For more details on custom domains, including setting canonical URLs for SEO, see the [custom domain documentation](/customize/custom-domain).

Check warning on line 300 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L300

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

## Next steps

Check warning on line 302 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L302

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L304

Don't use exclamation points in text.

Check warning on line 304 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L304

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 +335,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 338 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L338

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