Skip to content

PR Summary #2049

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

Closed
mintlify wants to merge 3 commits into from
Closed

PR Summary #2049

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a20d4b2
Update quickstart.mdx
mintlify[bot] Dec 3, 2025
0d348f9
Update organize/settings.mdx
mintlify[bot] Dec 4, 2025
94b30c1
Update organize/settings.mdx
mintlify[bot] Dec 4, 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
12 changes: 9 additions & 3 deletions organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
</ResponseField>

<ResponseField name="colors" type="object" required>
The colors used in your documentation. Colors are applied differently across themes. If you only provide a primary color, it will be used for all color elements.

Check warning on line 53 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L53 

Avoid using 'will'.

<Expandable title="Colors">
<ResponseField name="primary" type="string matching ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$" required>
Expand Down Expand Up @@ -115,7 +115,7 @@
Background image for your thumbnails. Can be a relative path or absolute URL.
</ResponseField>
<ResponseField name="fonts" type="object">
Font configuration for thumbnails. Only Google Fonts family names are supported.

Check warning on line 118 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L118 

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

<Expandable title="Fonts">
<ResponseField name="family" type="string" required>
Expand Down Expand Up @@ -527,7 +527,7 @@

<Expandable title="Interaction">
<ResponseField name="drilldown" type="boolean">
Control automatic navigation behavior when selecting navigation groups. Set to `true` to force navigation to the first page when a navigation group is expanded. Set to `false` to prevent navigation and only expand or collapse the group. Leave unset to use the theme's default behavior.

Check warning on line 530 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L530 

In general, use active voice instead of passive voice ('is expanded').
</ResponseField>
</Expandable>
</ResponseField>
Expand All @@ -537,7 +537,7 @@

<Expandable title="Metadata">
<ResponseField name="timestamp" type="boolean">
When enabled, all pages will display the date the content was last modified. Defaults to `false`.

Check warning on line 540 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L540 

Avoid using 'will'.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -615,7 +615,7 @@
Destination path to redirect to. Example: `/new-page`
</ResponseField>
<ResponseField name="permanent" type="boolean">
Whether to use a permanent redirect (301). Defaults to `true`.

Check warning on line 618 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L618 

Use parentheses judiciously.
</ResponseField>
</Expandable>
</ResponseField>
Expand Down Expand Up @@ -649,7 +649,7 @@
</Expandable>
</ResponseField>

### API Configurations

Check warning on line 652 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L652 

'API Configurations' should use sentence-style capitalization.

<ResponseField name="api" type="object">
API documentation and interactive playground settings.
Expand Down Expand Up @@ -747,10 +747,10 @@
</Expandable>
</ResponseField>

### SEO and search

Check warning on line 750 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L750 

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

Check warning on line 750 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L750 

'SEO and search' should use sentence-style capitalization.

<ResponseField name="seo" type="object">
SEO indexing configurations.

Check warning on line 753 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L753 

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

<Expandable title="Seo">
<ResponseField name="metatags" type="object">
Expand Down Expand Up @@ -991,6 +991,9 @@
<ResponseField name="description" type="string">
Custom description for the 404 error page. Supports Markdown formatting.
</ResponseField>
<ResponseField name="disableSuggestedPages" type="boolean">
Whether to disable suggested pages on the 404 error page. When set to `true`, the 404 page will not show recommended pages based on the URL. Defaults to `false`.
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>
Expand Down Expand Up @@ -1139,7 +1142,8 @@
"404": {
"redirect": false,
"title": "I can't be found",
"description": "What ever **happened** to this _page_?"
"description": "What ever **happened** to this _page_?",
"disableSuggestedPages": false
}
}
}
Expand Down Expand Up @@ -1312,7 +1316,8 @@
"404": {
"redirect": false,
"title": "I can't be found",
"description": "What ever **happened** to this _page_?"
"description": "What ever **happened** to this _page_?",
"disableSuggestedPages": false
}
}
}
Expand Down Expand Up @@ -1495,7 +1500,8 @@
"404": {
"redirect": false,
"title": "I can't be found",
"description": "What ever **happened** to this _page_?"
"description": "What ever **happened** to this _page_?",
"disableSuggestedPages": false
}
}
}
Expand Down
303 changes: 41 additions & 262 deletions quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,311 +4,90 @@
keywords: ["quickstart","deploy","get started","first steps"]
---

After completing this guide, you will 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**: [Create an account](https://mintlify.com/start) and complete onboarding.
</Info>

## Getting started
## Your documentation site

After you complete the onboarding process, your documentation site automatically deploys to a unique URL with this format:
After onboarding, your site deploys automatically 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.

### Install the GitHub App

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.
## Choose your workflow

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.
5. Select the repositories that 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"
/>
</Frame>

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

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

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

## Editing workflows

Mintlify offers two workflows for creating and maintaining your documentation:

<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.
</Card>

<Card title="Web editor workflow" icon="mouse-pointer-2" horizontal href="#web-editor-workflow">
For users who prefer a visual interface in their web browser. Click to jump to this section.
</Card>
<CardGroup cols={2}>
<Card title="Code-based" icon="terminal" href="#code-based-workflow">
Edit locally with Git and your preferred editor.
</Card>
<Card title="Web editor" icon="mouse-pointer-2" href="#web-editor-workflow">
Edit directly in your browser with a visual interface.
</Card>
</CardGroup>

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

### Install the CLI

Check warning on line 34 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L34 

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.
Requires [Node.js](https://nodejs.org/en) v20.17.0 or higher.
</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:

<CodeGroup>

```bash npm
npm i -g mint
```


```bash pnpm
pnpm add -g mint
```

</CodeGroup>

### Create a new project

Run `mint new` to create a new documentation project. See the [CLI installation guide](/installation#create-a-new-project) for details on the command and flags.

### Edit the documentation

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

1. Navigate to your documentation repository.
2. Open `index.mdx` and locate the top of the file:

```mdx index.mdx
---
title: "Introduction"
description: "This is the introduction to the documentation"
---
```

3. Update the `title` field to `"Hello World"`.

```mdx index.mdx {2}
---
title: "Hello World"
description: "This is the introduction to the documentation"
---
```

### Preview the changes

To preview the changes locally, run the following command:

```bash
mint dev
```

Your preview is available at `localhost:3000`.
### Edit and preview

<Frame>
<img
src="/images/quickstart/mintlify-dev-light.png"
alt="Mintlify Dev"
className="block dark:hidden"
/>
1. Open `index.mdx` in your documentation repository.
2. Update the `title` field to `"Hello World"`.
3. Run `mint dev` to preview at `localhost:3000`.

<img
src="/images/quickstart/mintlify-dev-dark.png"
alt="Mintlify Dev"
className="hidden dark:block"
/>
</Frame>
### Deploy

### 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`.

<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>
Push your changes to GitHub. Mintlify automatically builds and deploys your site.

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

### Access the web editor

1. Log in to your [dashboard](https://dashboard.mintlify.com).
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.
</Info>

<Frame>
<img
alt="The Mintlify web editor in the visual editor mode"
src="/images/quickstart/web-editor-light.png"
className="block dark:hidden"
/>

<img
alt="The Mintlify web editor in the visual editor mode"
src="/images/quickstart/web-editor-dark.png"
className="hidden dark:block"
/>
</Frame>

### 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".

<Frame>
<img
alt="Editing in Web Editor"
src="/images/quickstart/web-editor-editing-light.png"
className="block dark:hidden"
/>

<img
alt="Editing in Web Editor"
src="/images/quickstart/web-editor-editing-dark.png"
className="hidden dark:block"
/>
</Frame>

<Tip>
The editor provides a rich set of formatting tools and components. Type <kbd>/</kbd>

in the editor to open the command menu and access these tools.
</Tip>

### 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.
1. Open the [dashboard](https://dashboard.mintlify.com) and select **Editor**.
2. Select `index.mdx` and update the title to "Hello World".

Check warning on line 65 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L65 

Commas and periods go inside quotation marks.
3. Select **Publish** to deploy your changes.

<Tip>
Use branches to preview and review changes through pull requests before deploying to your live site.
Type <kbd>/</kbd> in the editor to access formatting tools and components.
</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).

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

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

<Table>
| Record Type | Name | Value | TTL |
| ----------- | ------------------- | -------------------- | ---- |
| CNAME | docs (or subdomain) | cname.vercel-dns.com | 3600 |
</Table>
## Add a custom domain

<Info>
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
</Info>
1. Go to [Domain Setup](https://dashboard.mintlify.com/settings/deployment/custom-domain) in your dashboard.
2. Enter your domain (e.g., `docs.yourcompany.com`).

Check warning on line 75 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L75 

Use parentheses judiciously.

Check warning on line 75 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L75 

Use 'for example' instead of 'e.g.'.
3. Add a CNAME record pointing to `cname.vercel-dns.com`.

## Next steps

Check warning on line 78 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L78 

'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:

<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.
</Card>

<Card title="Customize your theme" icon="paintbrush" horizontal href="customize/themes">
Learn how to customize colors, fonts, and the overall appearance of your documentation site.
</Card>

<Card title="Organize navigation" icon="map" horizontal href="organize/navigation">
Structure your documentation with intuitive navigation to help users find what they need.
</Card>

<Card title="Add interactive components" icon="puzzle" horizontal href="/components/accordions">
Enhance your documentation with interactive components like accordions, tabs, and code samples.
</Card>

<Card title="Set up API references" icon="code" horizontal href="/api-playground/overview">
Create interactive API references with OpenAPI and AsyncAPI specifications.
</Card>

## Troubleshooting

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

<AccordionGroup>
<Accordion title="Local preview not working">
Make sure you have Node.js v20.17.0 or higher installed and that you run the `mint dev` command from the directory containing your `docs.json` file.
</Accordion>
<Accordion title="Changes not reflecting on live site">
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.
</Accordion>
</AccordionGroup>
<CardGroup cols={2}>
<Card title="Configure settings" icon="settings" href="organize/settings">
Set up styling, navigation, and integrations.
</Card>
<Card title="Customize theme" icon="paintbrush" href="customize/themes">
Customize colors, fonts, and appearance.
</Card>
<Card title="Organize navigation" icon="map" href="organize/navigation">
Structure your documentation for easy discovery.
</Card>
<Card title="Add components" icon="puzzle" href="/components/accordions">
Use interactive components like accordions and tabs.
</Card>
</CardGroup>