Skip to content
Open
Show file tree
Hide file tree
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: 1 addition & 1 deletion components/color.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Color"
description: "Display color palettes with click-to-copy functionality."
description: "Display color palettes with click-to-copy."
keywords: ["color", "palette", "colors", "design system", "hex", "rgb", "rgba", "hsl", "oklch"]
---

Use the Color component to showcase color palettes in your documentation. Colors can be displayed in a compact grid or organized in a table with labeled rows.

Check warning on line 7 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L7

In general, use active voice instead of passive voice ('be displayed').

## Compact variant

Expand All @@ -22,7 +22,7 @@
<Color.Item name="blue-500" value="#3B82F6" />
<Color.Item name="blue-600" value="#2563EB" />
<Color.Item name="blue-700" value="#1D4ED8" />
<Color.Item name="blue-800" value="#1E40AF" />

Check warning on line 25 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L25

'r.I' should have one space.
</Color>
```

Expand All @@ -44,7 +44,7 @@

```mdx Table example
<Color variant="table">
<Color.Row title="Primary">

Check warning on line 47 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L47

'Color.Row' should use sentence-style capitalization.

Check warning on line 47 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L47

'r.R' should have one space.
<Color.Item name="primary-500" value="#3B82F6" />
<Color.Item name="primary-600" value="#2563EB" />
<Color.Item name="primary-700" value="#1D4ED8" />
Expand All @@ -58,7 +58,7 @@

## Color formats

The component supports all CSS color formats including hex, rgb, rgba, hsl, and oklch.

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'rgb'?

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'rgba'?

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'hsl'?

Check warning on line 61 in components/color.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/color.mdx#L61

Did you really mean 'oklch'?

<Color variant="compact">
<Color.Item name="hex" value="#FF5733" />
Expand Down
2 changes: 1 addition & 1 deletion deploy/ghes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["GitHub Enterprise Server", "GHES", "GitHub Enterprise"]
---

This guide walks you through setting up the Mintlify GitHub App on your GitHub Enterprise Server (GHES) installation. To connect a GHES instance to Mintlify, you must create a local version of our app within your self-hosted environment that communicates with our remote server.

Check warning on line 7 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L7

Use parentheses judiciously.

If you use a cloud-hosted GitHub instance, see the [GitHub](/deploy/github) page for setup instructions.

Expand All @@ -12,21 +12,21 @@

- Admin privileges on your GitHub Enterprise Server organization where you want to install the app
- Access to your organization's repositories where you want to install the app
- Network connectivity to communicate with our external services (see [Network requirements](#network-requirements) section below)

Check warning on line 15 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L15

Use parentheses judiciously.

### Network requirements

#### Outbound connectivity

Your GitHub Enterprise Server must be able to reach:
- Mintlify's API endpoints (https://leaves.mintlify.com)

Check warning on line 22 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L22

Use parentheses judiciously.
- Webhook receivers (port 443)

Check warning on line 23 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L23

Use parentheses judiciously.

#### Firewall configuration

The following outbound connections must be allowed:

Check warning on line 27 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L27

In general, use active voice instead of passive voice ('be allowed').
- Connections from Mintlify's static IP: `54.242.90.151`
- HTTPS (port 443) to Mintlify's service domains

Check warning on line 29 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L29

Use parentheses judiciously.
- DNS resolution for Mintlify's service domains

## Step 1: Register the GitHub App
Expand All @@ -52,7 +52,7 @@
- **GitHub App name:** `Mintlify`
- **Description:** `Integration with Mintlify services`
- **Homepage URL:** `https://mintlify.com`
- **User authorization callback URL:** `https://your-github-server.com/` (replace with your actual GHES domain)

Check warning on line 55 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L55

Use parentheses judiciously.

</Step>
</Steps>
Expand All @@ -61,7 +61,7 @@

<Steps>
<Step title="Set repository permissions">
Set the following permissions for the app. No Organization, Account, or Enterprise permissions are required:

Check warning on line 64 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L64

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

- **Checks:** Read and write
- **Contents:** Read and write
Expand Down Expand Up @@ -90,7 +90,7 @@
<Step title="Create the app">
Click **Create GitHub App**.

You'll be redirected to the app's settings page.

Check warning on line 93 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L93

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

<Step title="Generate private key">
Expand All @@ -102,9 +102,9 @@
<Step title="Note app credentials">
Record the following:

- **App ID** (visible at the top of the settings page)

Check warning on line 105 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L105

Use parentheses judiciously.
- **Client ID** (in the "About" section)

Check warning on line 106 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L106

Use parentheses judiciously.
- **Client Secret** (generate and record it securely)

Check warning on line 107 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L107

Use parentheses judiciously.
</Step>
</Steps>

Expand All @@ -119,11 +119,11 @@
<Step title="Choose installation scope">
Select either:

- **All repositories** (for organization-wide access)

Check warning on line 122 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L122

Use parentheses judiciously.
- **Only select repositories** (choose specific repositories)

Check warning on line 123 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L123

Use parentheses judiciously.

<Tip>
We recommend selecting "Only select repositories" and limiting the app to only the repositories where your documentation is located.

Check warning on line 126 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L126

In general, use active voice instead of passive voice ('is located').
</Tip>
</Step>

Expand All @@ -144,8 +144,8 @@
<Step title="Set webhook URL">
Configure the following:

- **Webhook URL:** `https://leaves.mintlify.com/github-enterprise/:subdomain` (replace `:subdomain` with the URL that we provide you with)

Check warning on line 147 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L147

Use parentheses judiciously.

Check warning on line 147 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L147

Use 'webhook' instead of 'Webhook'.
- **Webhook secret:** Generate a random string (32+ characters) and record it securely. Mintlify can also generate this and provide it to you.

Check warning on line 148 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L148

Use 'webhook' instead of 'Webhook'.

Check warning on line 148 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L148

Use parentheses judiciously.
</Step>
</Steps>

Expand All @@ -154,16 +154,16 @@

### Required credentials
- GitHub Enterprise Server base URL: https://your-github-server.com
- App ID: (from step 3)

Check warning on line 157 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L157

Use parentheses judiciously.
- App client ID: (from step 3)

Check warning on line 158 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L158

Use parentheses judiciously.
- App client secret: (from step 3)

Check warning on line 159 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L159

Use parentheses judiciously.
- Installation ID: (from step 4)

Check warning on line 160 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L160

Use parentheses judiciously.
- Private key: The entire contents of the `.pem` file (should be shared via secure file transfer)

Check warning on line 161 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L161

Use parentheses judiciously.

Check warning on line 161 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L161

In general, use active voice instead of passive voice ('be shared').
- Webhook secret: (from step 5)

Check warning on line 162 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L162

Use 'webhook' instead of 'Webhook'.

Check warning on line 162 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L162

Use parentheses judiciously.

### Optional credentials for troubleshooting
- Organization name: Your GitHub organization name
- Repository names: Specific repositories where the app is installed

Check warning on line 166 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L166

In general, use active voice instead of passive voice ('is installed').
- GitHub Enterprise Server version: Found in your site admin dashboard

## Mintlify connection
Expand All @@ -172,7 +172,7 @@
- Integrate your GHES environment with an existing Mintlify deployment.
- Integrate your GHES environment with a new Mintlify deployment that we provision for you.

After your GHES environment is integrated with a Mintlify deployment, you are ready to enable webhooks for your GitHub App.

Check warning on line 175 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L175

In general, use active voice instead of passive voice ('is integrated').

<Note>
The webhook URL may change based on our configuration. We test the integration and provide you with the new URL.
Expand All @@ -194,7 +194,7 @@
</Step>
</Steps>

## FAQ and Troubleshooting

Check warning on line 197 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L197

'FAQ and Troubleshooting' should use sentence-style capitalization.

<AccordionGroup>
<Accordion title="The app installation is failing with permission errors.">
Expand All @@ -208,7 +208,7 @@
<Accordion title="Webhooks aren't being delivered">
- Verify the webhook URL is correct and accessible.
- Ensure your firewall allows outbound HTTPS connections.
- Check the webhook secret matches what was configured.

Check warning on line 211 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L211

In general, use active voice instead of passive voice ('was configured').
- Review webhook delivery logs in the "Advanced" tab of your GitHub App settings.
</Accordion>

Expand All @@ -219,8 +219,8 @@
</Accordion>

<Accordion title="The app installs, but doesn't respond to events.">
- Ensure webhooks are being delivered and acknowledged by our server with response code 200.

Check warning on line 222 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L222

In general, use active voice instead of passive voice ('being delivered').
- Required permissions were granted during installation.

Check warning on line 223 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L223

In general, use active voice instead of passive voice ('were granted').
</Accordion>

<Accordion title="Can I limit which repositories the app accesses?">
Expand All @@ -230,15 +230,15 @@
<Accordion title="How do I update app permissions later?">
- Go to the app settings as a site admin.
- Modify permissions as needed.
- The app will need to be re-approved by organization owners.

Check warning on line 233 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L233

Avoid using 'will'.
- Notify us of any permission changes as they may affect functionality.
- Notify us of any permission changes as they may affect features.
</Accordion>

<Accordion title="Our GHES is behind a corporate firewall, nginx proxy, or similar setup.">
You must:

- Whitelist our service domains in your firewall.
- Ensure outbound HTTPS (port 443) connectivity.

Check warning on line 241 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L241

Use parentheses judiciously.
- If direct internet access is not allowed, set up a proxy.
</Accordion>

Expand All @@ -252,7 +252,7 @@
- Your GitHub Enterprise Server version.
- Specific error messages.
- Screenshots of any issues.
- Network/firewall configuration details (if relevant).

Check warning on line 255 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L255

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

2 changes: 1 addition & 1 deletion deploy/route53-cloudfront.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@
3. For the Origin domain, input `[SUBDOMAIN].mintlify.dev` where `[SUBDOMAIN]` is your project's unique subdomain.

<Frame>
![CloudFront "Create distribution" page showing "acme.mintlify.dev" as the origin domain.](/images/cloudfront/origin-name.png)

Check warning on line 42 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L42

Use 'Dev' instead of 'dev'.
</Frame>

4. For "Web Application Firewall (WAF)," enable security protections.

Check warning on line 45 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L45

Use parentheses judiciously.

<Frame>
![Web Application Firewall (WAF) options with "Enable security protections" selected.](/images/cloudfront/enable-security-protections.png)

Check warning on line 48 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L48

Use parentheses judiciously.
</Frame>

5. The remaining settings should be default.
Expand All @@ -59,10 +59,10 @@
![A CloudFront distribution with the "Origins" tab highlighted.](/images/cloudfront/origins.png)
</Frame>

2. Find your staging URL that mirrors the main domain. This is highly variant depending on how your landing page is hosted. For example, the Mintlify staging URL is [mintlify-landing-page.vercel.app](https://mintlify-landing-page.vercel.app).

Check warning on line 62 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L62

In general, use active voice instead of passive voice ('is hosted').

<Info>
If your landing page is hosted on Webflow, use Webflow's staging URL. It would look like `.webflow.io`.

Check warning on line 65 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L65

In general, use active voice instead of passive voice ('is hosted').

If you use Vercel, use the `.vercel.app` domain available for every project.
</Info>
Expand Down Expand Up @@ -105,21 +105,21 @@
</Frame>

<Info>
If `.well-known/*` is too generic, it can be narrowed down to 2 behaviors at a minimum for Vercel:

Check warning on line 108 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L108

In general, use active voice instead of passive voice ('be narrowed').
- `/.well-known/vercel/*` - Required for Vercel domain verification
- `/.well-known/acme-challenge/*` - Required for Let's Encrypt certificate verification
</Info>

### Your subpath

Create a behavior with a **Path pattern** of your chosen subpath, for example `/docs`, with **Origin and origin groups** pointing to the `.mintlify.dev` URL (in our case `acme.mintlify.dev`).

Check warning on line 115 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L115

Use parentheses judiciously.

- Set "Cache policy" to **CachingOptimized**.
- Set "Origin request policy" to **AllViewerExceptHostHeader**.
- Set Viewer Protocol Policy to **Redirect HTTP to HTTPS**

<Frame>
![CloudFront "Create behavior" page with a "Path pattern" of "/docs/*" and "Origin and origin groups" pointing to the `acme.mintlify.dev` URL.](/images/cloudfront/behavior-1.png)

Check warning on line 122 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L122

Use 'Dev' instead of 'dev'.
</Frame>

### Your subpath with wildcard
Expand All @@ -143,10 +143,10 @@
Lastly, we're going to edit the `Default (*)` behavior.

<Frame>
![A CloudFront distribution with the "Default (*)" behavior selected and the Edit button emphasized.](/images/cloudfront/default-behavior-1.png)

Check warning on line 146 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L146

Use parentheses judiciously.
</Frame>

1. Change the default behavior's **Origin and origin groups** to the staging URL (in our case `mintlify-landing-page.vercel.app`).

Check warning on line 149 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L149

Use parentheses judiciously.

<Frame>
![CloudFront "Edit behavior" page with the "Origin and origin groups" input field highlighted.](/images/cloudfront/default-behavior-2.png)
Expand All @@ -154,9 +154,9 @@

2. Select **Save changes**.

### Check behaviors are set up correctly

Check warning on line 157 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L157

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

If you follow the above steps, your behaviors should look like this:

Check warning on line 159 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L159

Use 'preceding' instead of 'above'.

<Frame>
![CloudFront "Behaviors" page with 4 behaviors: `/docs/*`, `/docs`, `Default`, and `/.well-known/*`.](/images/cloudfront/all-behaviors.png)
Expand All @@ -164,7 +164,7 @@

## Preview distribution

You can now test if your distribution is set up properly by going to the "General" tab and visiting the **Distribution domain name** URL.

Check warning on line 167 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L167

In general, use active voice instead of passive voice ('is set').

<Frame>
![CloudFront "General" tab with the "Distribution domain name" URL highlighted.](/images/cloudfront/preview-distribution.png)
Expand All @@ -172,9 +172,9 @@

All pages should be directing to your main landing page, but if you append your chosen subpath, for example `/docs`, to the URL, you should see it going to your Mintlify documentation instance.

## Connect with Route53

Check warning on line 175 in deploy/route53-cloudfront.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/route53-cloudfront.mdx#L175

'Connect with Route53' should use sentence-style capitalization.

Now, we're going to bring the functionality of the CloudFront distribution into your primary domain.
Now, we're going to bring the CloudFront distribution into your primary domain.

<Note>
For this section, you can also refer to AWS's official guide on [Configuring
Expand Down
2 changes: 1 addition & 1 deletion guides/content-templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@
Include practical tips that help users avoid common mistakes or work more efficiently.
</Tip>

## Verify the result (optional)

Check warning on line 55 in guides/content-templates.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-templates.mdx#L55

Use parentheses judiciously.

If success is ambiguous, explain how users can confirm they completed the task successfully.

## Troubleshooting (optional)

Check warning on line 59 in guides/content-templates.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-templates.mdx#L59

Use parentheses judiciously.

Address common issues users might encounter:

Expand Down Expand Up @@ -176,7 +176,7 @@

## Reference template

Use reference documentation when users need to look up specific details about your product's functionality. Reference docs prioritize accuracy, consistency, and scannability.
Use reference documentation when users need to look up specific details about your product's features. Reference docs prioritize accuracy, consistency, and scannability.

Check warning on line 179 in guides/content-templates.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-templates.mdx#L179

Did you really mean 'scannability'?

````mdx Reference template
---
Expand Down
2 changes: 1 addition & 1 deletion guides/content-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@
This page explains different content types, when to use each one, and how to approach writing for each type.
</Tip>

Documentation should be organized around the specific goal you're trying to help people achieve.

Check warning on line 11 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L11

In general, use active voice instead of passive voice ('be organized').

## Categorize using the Diátaxis framework

The [Diátaxis framework](https://diataxis.fr) is a helpful guide for categorizing content based on your audience's needs. Documentation can generally be mapped into one of these types:

Check warning on line 15 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L15

In general, use active voice instead of passive voice ('be mapped').

1. Tutorials: Learning-oriented content for new users
2. How-to guides: Task-oriented guidance for specific problems
Expand All @@ -38,17 +38,17 @@

## Writing for each type

### Tutorials (Learning-oriented)

Check warning on line 41 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L41

'Tutorials (Learning-oriented)' should use sentence-style capitalization.

Check warning on line 41 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L41

Use parentheses judiciously.

- **Audience goal**: Learn something new through step-by-step instructions.
- **Characteristics**: Sequential and assumes no prior knowledge.
- **Writing approach**:
- Set expectations of what the user will achieve after reading.

Check warning on line 46 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L46

Avoid using 'will'.
- Use clear, incremental steps. Minimize choices that need to be made by the user.

Check warning on line 47 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L47

In general, use active voice instead of passive voice ('be made').
- Point out milestones along the way.
- Minimize theory and focus on concrete actions.

### How-To Guides (Problem-oriented)

Check warning on line 51 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L51

'How-To Guides (Problem-oriented)' should use sentence-style capitalization.

Check warning on line 51 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L51

Use parentheses judiciously.

- **Audience goal**: Perform a specific task correctly.
- **Characteristics**: Goal-driven and assumes some prior knowledge.
Expand All @@ -57,16 +57,16 @@
- Describe a logical sequence and omit unnecessary details.
- Minimize context beyond what is necessary.

### Reference (Information-oriented)

Check warning on line 60 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L60

Use parentheses judiciously.

- **Audience goal**: Find details about a product's functionality.
- **Audience goal**: Find details about a product's features.
- **Characteristics**: Unambiguous, product-focused, scannable.
- **Writing approach**:
- Be scannable and concise.
- Prioritize consistency.
- Avoid explanatory content. Focus on examples that are easy to copy and modify.

### Explanation (Understanding-oriented)

Check warning on line 69 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L69

'Explanation (Understanding-oriented)' should use sentence-style capitalization.

Check warning on line 69 in guides/content-types.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/content-types.mdx#L69

Use parentheses judiciously.

- **Audience goal**: Expand general understanding of a concept or highly complex feature.
- **Characteristics**: Theoretical, potentially opinionated, broad in scope.
Expand Down
2 changes: 1 addition & 1 deletion guides/cursor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

Transform Cursor into a documentation expert that knows your components, style guide, and best practices.

## Use Cursor with Mintlify

Check warning on line 9 in guides/cursor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/cursor.mdx#L9

'Use Cursor with Mintlify' should use sentence-style capitalization.

Cursor rules provide persistent context about your documentation, ensuring more consistent suggestions that fit your standards and style.

* **Project rules** are stored in your documentation repository and shared with your team.

Check warning on line 13 in guides/cursor.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/cursor.mdx#L13

In general, use active voice instead of passive voice ('are stored').
* **User rules** apply to your personal Cursor environment.

We recommend creating project rules for your docs so that all contributors have access to the same rules.
Expand Down Expand Up @@ -371,7 +371,7 @@

<Update label="Version 2.1.0" description="Released March 15, 2024">
## New features
- Added bulk user import functionality
- Added bulk user import
- Improved error messages with actionable suggestions

## Bug fixes
Expand Down
2 changes: 1 addition & 1 deletion guides/linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Internal links

Link to other pages in your documentation using root-relative paths. Root-relative paths start from the root of your documentation directory and work consistently regardless of where the linking page is located.

Check warning on line 11 in guides/linking.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/linking.mdx#L11

In general, use active voice instead of passive voice ('is located').

```mdx
* [Quickstart guide](/quickstart)
Expand Down Expand Up @@ -46,7 +46,7 @@
* [Customize your playground](/api-playground/overview#customize-your-playground)
* [Cards properties](/components/cards#properties)

### How anchor links are generated

Check warning on line 49 in guides/linking.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/linking.mdx#L49

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

Anchor links are automatically created from header text.

Expand All @@ -62,7 +62,7 @@
| `#### Step 1: Install` | `#step-1-install` |

<Note>
Headers with the `noAnchor` prop will not generate anchor links. See [Format text](/create/text#disabling-anchor-links) for details.

Check warning on line 65 in guides/linking.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/linking.mdx#L65

Avoid using 'will'.
</Note>

## Link to API endpoints
Expand All @@ -86,7 +86,7 @@

### Write descriptive link text

Use clear, descriptive text that indicates what users will find when they click.

Check warning on line 89 in guides/linking.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/linking.mdx#L89

Avoid using 'will'.

<CodeGroup>

Expand Down Expand Up @@ -122,7 +122,7 @@
```mdx
To customize your documentation appearance, configure [themes](/customize/themes)
and [fonts](/customize/fonts) in your settings. You can also add
[custom scripts](/customize/custom-scripts) for advanced functionality.
[custom scripts](/customize/custom-scripts) for advanced features.
```

### Link to prerequisites
Expand Down
2 changes: 1 addition & 1 deletion installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
alt="Decorative graphic representing the CLI."
/>

Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and functionality, and catch issues like broken links or accessibility problems.
Use the [CLI](https://www.npmjs.com/package/mint) to preview your documentation locally as you write and edit. View changes in real-time before deploying, test your documentation site's appearance and features, and catch issues like broken links or accessibility problems.

The CLI also has utilities for maintaining your documentation, including commands to rename files, validate OpenAPI specifications, and migrate content between formats.

## Prerequisites

- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Use parentheses judiciously.

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Spell out 'LTS', if it's unfamiliar to the audience.
- [Git](https://git-scm.com/downloads) installed
- Your documentation repository cloned locally

Expand Down Expand Up @@ -181,7 +181,7 @@
mint broken-links
```

The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.

Check warning on line 184 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L184

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

To also check anchor links like `/path/to/page#anchor`, use the `--check-anchors` flag:

Expand Down Expand Up @@ -217,7 +217,7 @@

Use flags to configure the validation command.

- `--groups [groupname]`: Mock user groups for validation (useful when testing group-based access control)

Check warning on line 220 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L220

Use parentheses judiciously.
- `--disable-openapi`: Disable OpenAPI file generation during validation

### Check OpenAPI spec
Expand All @@ -228,7 +228,7 @@
mint openapi-check <OpenAPI filename or URL>
```

Pass a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).

Check warning on line 231 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L231

Use parentheses judiciously.

### Rename files

Expand Down Expand Up @@ -300,7 +300,7 @@
```
</Accordion>
<Accordion title="Client version shows 'none' after installation">
If you run `mint version` and the client version displays as `none`, the CLI may be unable to download the client application due to a corporate firewall or VPN blocking the download.

Check warning on line 303 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L303

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

**Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI.
</Accordion>
Expand Down
2 changes: 1 addition & 1 deletion migration-services/enterprise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## What to expect for your migration

A migration is a point-in-time transfer of your documentation that requires a code freeze. We migrate your documentation, API reference pages, branding (logos, colors, and fonts), and navigation structure. Migration services also include design or information architecture consultation and custom component development such as landing pages or custom integrations.

Check warning on line 10 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L10

Use parentheses judiciously.

Your migration includes a staging link to review progress and a 7-day feedback window after delivery to address any issues with content, assets, or branding.

Expand Down Expand Up @@ -39,7 +39,7 @@
</Step>

<Step title="Feedback window (seven business days)">
Submit any feedback on content, assets, or branding. We address all in-scope issues within the same timeframe.

Check warning on line 42 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L42

Did you really mean 'timeframe'?
</Step>

<Step title="Go-live support">
Expand All @@ -52,20 +52,20 @@
We work with vetted third-party vendors and conduct an internal quality audit before delivery. Here's what we check for:

<Card title="Content completeness" icon="file-check">
- All documentation from your source has been migrated.

Check warning on line 55 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L55

In general, use active voice instead of passive voice ('been migrated').
- Content is properly formatted with Mintlify components.
- Navigation structure matches your specifications.
</Card>

<Card title="Visual elements" icon="palette">
- Images and videos display correctly.
- Custom fonts are applied throughout.

Check warning on line 62 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L62

In general, use active voice instead of passive voice ('are applied').
- Light and dark mode logos are used appropriately.

Check warning on line 63 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L63

In general, use active voice instead of passive voice ('are used').
- Color schemes meet contrast requirements in both modes.
</Card>

<Card title="Functionality" icon="rocket">
- All links work correctly (no broken links).

Check warning on line 68 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L68

Use parentheses judiciously.
- Table of contents renders properly.
- React components function as expected.
- No performance issues.
Expand All @@ -80,7 +80,7 @@
3. [Configure your custom domain](/customize/custom-domain).
4. **Test before going live** - Before switching over from your old documentation:
- Review all pages on your staging link.
- Test navigation and search functionality.
- Test navigation and search.
- Verify all images and videos load correctly.
- Check that code blocks render properly.
- Test on mobile and desktop.
Expand All @@ -98,7 +98,7 @@
</Accordion>

<Accordion title="Can I request changes after delivery?">
Yes. You have a 7-day feedback window after delivery to request changes to content, assets, or branding. We address all in-scope feedback within the same timeframe and work with you right until you are ready to go live.

Check warning on line 101 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L101

Did you really mean 'timeframe'?
</Accordion>

<Accordion title="What do I need to do after the migration is complete?">
Expand All @@ -111,12 +111,12 @@
</Accordion>

<Accordion title="Can I customize the navigation structure?">
Yes. You can provide a custom information architecture and we will implement it. We also work with you on custom component development if that is needed and supported by the platform.

Check warning on line 114 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L114

Avoid using 'will'.

Check warning on line 114 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L114

In general, use active voice instead of passive voice ('is needed').
</Accordion>

<Accordion title="What happens if my documentation changes during the migration?">
Since migrations require a code freeze, any changes made to your source documentation after submission won't be included. We recommend completing all updates before starting the migration.

Check warning on line 118 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L118

In general, use active voice instead of passive voice ('be included').

If this is not possible, our team will work with you to set short sprints to migrate certain sections or reserve dedicated time post the first sprint to migrate the delta changes made during the migration.

Check warning on line 120 in migration-services/enterprise.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/enterprise.mdx#L120

Avoid using 'will'.
</Accordion>
</AccordionGroup>
2 changes: 1 addition & 1 deletion migration-services/pro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## What to expect for your migration

A migration is a point-in-time transfer of your documentation that requires a code freeze. We migrate your documentation, branding (logos, colors, and fonts), API reference pages, and navigation structure.

Check warning on line 10 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L10

Use parentheses judiciously.

Your migration includes a staging link to review progress and a 3-day feedback window after delivery to address any issues with content, assets, or branding.

Expand All @@ -15,7 +15,7 @@
Migration services **do not** include:
- Dynamic syncing of your documentation
- Design or information architecture consultation
- Custom component development (landing pages, custom integrations, etc.)

Check warning on line 18 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L18

Use parentheses judiciously.
- Redirects setup
- Analytics setup
</Info>
Expand All @@ -42,7 +42,7 @@
</Step>

<Step title="Feedback window (three business days)">
Submit any feedback on content, assets, or branding. We address all in-scope issues within the same timeframe.

Check warning on line 45 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L45

Did you really mean 'timeframe'?
</Step>

<Step title="Go-live support">
Expand All @@ -55,20 +55,20 @@
We work with vetted third-party vendors and conduct an internal quality audit before delivery. Here's what we check for:

<Card title="Content completeness" icon="file-check">
- All documentation from your source has been migrated.

Check warning on line 58 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L58

In general, use active voice instead of passive voice ('been migrated').
- Content is properly formatted with Mintlify components.
- Navigation structure matches your specifications.
</Card>

<Card title="Visual elements" icon="palette">
- Images and videos display correctly.
- Custom fonts are applied throughout.

Check warning on line 65 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L65

In general, use active voice instead of passive voice ('are applied').
- Light and dark mode logos are used appropriately.

Check warning on line 66 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L66

In general, use active voice instead of passive voice ('are used').
- Color schemes meet contrast requirements in both modes.
</Card>

<Card title="Functionality" icon="rocket">
- All links work correctly (no broken links).

Check warning on line 71 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L71

Use parentheses judiciously.
- Table of contents renders properly.
- React components function as expected.
- No performance issues.
Expand All @@ -83,7 +83,7 @@
3. [Configure your custom domain](https://www.mintlify.com/docs/customize/custom-domain).
4. **Test before going live** - Before switching over from your old documentation:
- Review all pages on your staging link.
- Test navigation and search functionality.
- Test navigation and search.
- Verify all images and videos load correctly.
- Check that code blocks render properly.
- Test on mobile and desktop.
Expand All @@ -101,7 +101,7 @@
</Accordion>

<Accordion title="Can I request changes after delivery?">
Yes. You have a 3-day feedback window after delivery to request changes to content, assets, or branding. We address all in-scope feedback within the same timeframe.

Check warning on line 104 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L104

Did you really mean 'timeframe'?
</Accordion>

<Accordion title="What do I need to do after the migration is complete?">
Expand All @@ -114,10 +114,10 @@
</Accordion>

<Accordion title="Can I customize the navigation structure?">
Yes. You can provide a custom information architecture in the migration form, and we'll implement it. However, custom component development (like custom landing pages) is not included in the migration service.

Check warning on line 117 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L117

Use parentheses judiciously.
</Accordion>

<Accordion title="What happens if my documentation changes during the migration?">
Since migrations require a code freeze, any changes made to your source documentation after submission won't be included. We recommend completing all updates before starting the migration.

Check warning on line 121 in migration-services/pro.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration-services/pro.mdx#L121

In general, use active voice instead of passive voice ('be included').
</Accordion>
</AccordionGroup>
2 changes: 1 addition & 1 deletion migration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@
</svg>} horizontal />
</Columns>

If your documentation is hosted on another platform, see the manual migration steps.

Check warning on line 105 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L105

In general, use active voice instead of passive voice ('is hosted').

### Installing the scraper

Expand All @@ -114,7 +114,7 @@

### Scraping pages and sections

The migration tool automatically detects your documentation platform and converts your content. Prepared files are stored locally in `./docs` by default.

Check warning on line 117 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L117

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

For large documentation sites, migrate smaller sections one at a time rather than the entire site at once.

Expand Down Expand Up @@ -152,7 +152,7 @@

After scraping your existing documentation platform, you are ready to build your docs on Mintlify.

Confirm that all of your pages have been migrated then add these files to the documentation repository that you created during the onboarding process. This is usually a GitHub repository.

Check warning on line 155 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L155

In general, use active voice instead of passive voice ('been migrated').
</Tab>
<Tab title="Manual migration">

Expand All @@ -160,11 +160,11 @@

### Content migration

To migrate your content to Mintlify, you will need:

Check warning on line 163 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L163

Avoid using 'will'.

- A valid `docs.json` for your site settings and navigation. See [Global settings](/organize/settings) and [Navigation](/organize/navigation) for more information.
- A Markdown file (`.md` or `.mdx`) for each page of your documentation. MDX is the recommended format. See [Pages](/organize/pages) for more information.

Check warning on line 166 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L166

Use parentheses judiciously.
- (Optional) An OpenAPI specification for your API endpoint pages. See [OpenAPI setup](/api-playground/openapi-setup) for more information.

Check warning on line 167 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L167

Use parentheses judiciously.

1. If your content is already in Markdown format, copy the content to your Mintlify project. Otherwise, convert your content to MDX format.
2. Create your `docs.json` referencing the paths to your Markdown pages.
Expand All @@ -187,13 +187,13 @@

## Post-migration checklist

After completing your migration (automated or manual), we recommend checking:

Check warning on line 190 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L190

Use parentheses judiciously.

- All pages render
- Navigation works as intended
- Internal links resolve properly
- Images and assets load correctly
- Code blocks display with proper syntax highlighting
- Search functionality works
- Search works
- Deployment is configured

Check warning on line 198 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L198

In general, use active voice instead of passive voice ('is configured').
- Custom domain is set up

Check warning on line 199 in migration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

migration.mdx#L199

In general, use active voice instead of passive voice ('is set').