Skip to content

Simplify quickstart page explanations #1660

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft

Simplify quickstart page explanations #1660

Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
b1091ec
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
ee5a6cc
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
3b0b1e8
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
461bad2
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
c49c565
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
91aeb8e
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
450ce20
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
bbababb
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
17f0587
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
4430b19
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
717ddd5
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
b97604d
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
fb26b96
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
2c4430a
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
2d5d67f
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
a194a6e
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
811ad03
Update quickstart.mdx
mintlify[bot] Oct 30, 2025
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
54 changes: 17 additions & 37 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,28 @@
description: "Deploy your documentation in minutes"
---

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.
Set up and deploy your documentation site in minutes.

<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

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/).
After onboarding, your site deploys to `https://<your-project-name>.mintlify.app`. Find your URL on the Overview page of your [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" />
</Frame>

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.
Use this URL for testing and sharing with your team.

### Install the GitHub App

Check warning on line 25 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L25 

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

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 your dashboard.
Install the GitHub App to automate deployment when you push changes.

1. Navigate to **Settings** in your Mintlify dashboard.
2. Select **GitHub App** from the sidebar.
Expand All @@ -54,16 +44,16 @@
### Authorize your GitHub account

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

Check warning on line 47 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L47 

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L51 

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

## Editing workflows

Mintlify offers two workflows for creating and maintaining your documentation:
Choose your preferred workflow:

<Card title="Code-based workflow" icon="terminal" horizontal href="#code-based-workflow">
For users who prefer working with existing tools in their local environment. Click to jump to this section.
Expand All @@ -75,15 +65,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.
Work locally with your existing development tools and Git workflow.

### Install the CLI

Check warning on line 70 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L70 

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

<Info>
**Prerequisite**: The CLI requires [Node.js](https://nodejs.org/en) v19 or higher.

Check warning on line 73 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L73 

': T' should be in lowercase.

Check warning on line 73 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L73 

Use 'command-line tool' instead of 'CLI'.
</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:
Install the [mint](https://www.npmjs.com/package/mint) CLI:

Check warning on line 76 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L76 

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

<CodeGroup>
```bash npm
Expand All @@ -97,7 +87,7 @@

### Edit the documentation

After setting up your environment, you can start editing your documentation files. For example, update the title of the introduction page:
Edit your documentation files. For example, update the introduction page title:

1. Open your repository created during onboarding.
2. Open `index.mdx` and locate the top of the file:
Expand All @@ -120,13 +110,13 @@

### Preview the changes

To preview the changes locally, run the following command:
Preview changes locally:

```bash
mint dev
```

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

Check warning on line 119 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L119 

Avoid using 'will'.

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

### Push the changes

When you are ready to publish your changes, push them to your repository.

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`.
Push changes to your repository. Mintlify automatically builds and deploys updates. Monitor deployment status in your GitHub commit history or the [dashboard](https://dashboard.mintlify.com).

<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.
</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.
Edit documentation in your browser with a visual interface.

### Access the web editor

Expand All @@ -155,7 +141,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 144 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L144 

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

Check warning on line 144 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L144 

Avoid using 'will'.

Check warning on line 144 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L144 

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

<Frame>
Expand All @@ -165,11 +151,7 @@

### Edit the documentation

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

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

Then, in the editor, update the title field to "Hello World".
Navigate to `index.mdx` in the file explorer and update the title field to "Hello World".

Check warning on line 154 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L154 

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 @@ -182,40 +164,38 @@

### 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.
Select **Publish** in the top-right corner to deploy your changes.

<Tip>
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).
See the [web editor documentation](/editor) for details on branches and pull requests.

## 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 a custom domain for production. Navigate to the [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) page in your dashboard.

<Frame>
<img src="/images/quickstart/custom-domain-light.png" alt="Custom Domain" className="block dark:hidden" />
<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 184 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L184 

Use parentheses judiciously.

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

Check warning on line 189 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L189 

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L196 

'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:
Your documentation site is live. Here are suggested next steps:

Check warning on line 198 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L198 

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

<Card title="Configure your global settings" icon="settings" href="organize/settings" horizontal>
Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
Expand All @@ -235,7 +215,7 @@

## Troubleshooting

If you encounter issues during the setup process, check these common troubleshooting solutions:
Common troubleshooting solutions:

<AccordionGroup>
<Accordion title="Local preview not working">
Expand All @@ -245,6 +225,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 228 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L228 

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