Skip to content
Merged
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
6 changes: 3 additions & 3 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@

## Connect additional integrations from Slack

Once your Slack workspace is connected, you can ask the agent in Slack to set up any third-party integration that it should use as context. The agent uses [Composio](https://docs.composio.dev/toolkits) to support a broad catalog of third-party services, including issue trackers, knowledge bases, CRMs, and developer tools.
After you connect your Slack workspace, you can ask the agent in Slack to set up any third-party integration that it should use as context. The agent uses [Composio](https://docs.composio.dev/toolkits) to support a broad catalog of third-party services, including issue trackers, knowledge bases, CRMs, and developer tools.

Check warning on line 37 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L37

Did you really mean 'CRMs'?

To add a new integration from Slack:

Expand All @@ -46,7 +46,7 @@
3. Click the link, sign in to the third-party service, and approve the requested permissions.
4. Return to Slack. The agent confirms the connection and can immediately use the integration as context for future requests.

Integrations that you connect from Slack are scoped to individual Slack users, so each teammate sets up their own connections and the agent uses the connections of whoever sent the message. If a Slack user has not connected a service, the agent falls back to the organization-level integrations installed from the [Agent](https://dashboard.mintlify.com/products/agent) page in the dashboard.
Integrations that you connect from Slack apply to individual Slack users, so each teammate sets up their own connections and the agent uses the connections of whoever sent the message. If a Slack user has not connected a service, the agent falls back to the organization-level integrations installed from the [Agent](https://dashboard.mintlify.com/products/agent) page in the dashboard.

To remove or reauthorize an organization-level integration, use the **Agent settings** section of the [Agent](https://dashboard.mintlify.com/products/agent) page.

Expand All @@ -71,7 +71,7 @@

Example questions:
- "Which pages mention the API rate limit?"
- "How do I set up authentication?"

Check warning on line 74 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L74

Avoid first-person pronouns such as ' I '.
- "How is our navigation structured?"

## Update documentation
Expand All @@ -96,7 +96,7 @@
- "Document the new endpoints added in `acme/backend#1234`."
- "What repositories do you have access to?"

Cloned repositories are read-only. The agent uses them for context, but always opens pull requests against your documentation repository.
The agent treats cloned repositories as read-only. It uses them for context, but always opens pull requests against your documentation repository.

## Track progress in real time

Expand Down
2 changes: 1 addition & 1 deletion ai/mintlify-mcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
| :-- | :-- | :-- |
| **Audience** | Your end users | Your team |
| **Access** | Read and search published pages | Read, edit, restructure, save |
| **Endpoint** | `/mcp` on your site domain | Hosted by Mintlify, scoped to your project |
| **Endpoints** | `/mcp` on your site domain | Hosted by Mintlify, scoped to your project |

Check warning on line 23 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L23

Use 'endpoints?' instead of 'Endpoints'.
| **Output** | Search results and page content | Content edits, navigation changes, pull requests |

## Connect to the Mintlify MCP
Expand Down Expand Up @@ -134,8 +134,8 @@
After you connect the Mintlify MCP, you can drive it with natural-language prompts. For example:

- _"Check out a branch called `add-billing-faq` and create a new page under the FAQ group titled 'Billing'. Draft answers for the five questions in this Linear issue."_
- _"Find every page that mentions the deprecated `legacy_token` field and update the example to use `api_key` instead. Save as a PR titled 'docs: replace legacy\_token references'."_

Check warning on line 137 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L137

Did you really mean 'legacy_token'?
- _"Reorganize the API reference: move the webhooks pages into a new group called 'Webhooks' and update the icons to match the rest of the section."_

Check warning on line 138 in ai/mintlify-mcp.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/mintlify-mcp.mdx#L138

Use 'REST' instead of 'rest'.

## Best practices

Expand Down
2 changes: 1 addition & 1 deletion ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
The MCP search tool supports optional parameters that AI applications use to control and refine search results.

- **`pageSize`**: Number of results to return, between 1 and 50. Defaults to 10.
- **`scoreThreshold`**: Minimum relevance score between 0 and 1. Only returns results at or above this threshold. Use this to filter out low-relevance matches.
- **`scoreThreshold`**: Minimum relevance score between 0 and 1. Returns only results at or above this score. Use this to filter out low-relevance matches.

Check warning on line 51 in ai/model-context-protocol.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/model-context-protocol.mdx#L51

Use 'preceding' instead of 'above'.
- **`version`**: Filter results to a specific documentation version. For example, `'v0.7'`. Only returns content tagged with the specified version or content available across all versions.
- **`language`**: Filter results to a specific language code. For example, `'en'`, `'zh'`, or `'es'`. Only returns content in the specified language or content available across all languages.

Expand Down
2 changes: 1 addition & 1 deletion api/agent/v2/create-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Create agent job"
openapi: /admin-openapi.json POST /v2/agent/{projectId}/job

Check warning on line 3 in api/agent/v2/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/create-agent-job.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["agent job", "create", "automation", "automate"]

---

This endpoint creates a background agent job. The job runs asynchronously — use the [get agent job](/api/agent/v2/get-agent-job) endpoint to poll for status updates.

Check warning on line 8 in api/agent/v2/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/create-agent-job.mdx#L8

Don't put a space before or after a dash.

If the agent edits files successfully, a pull request is automatically created and the `prLink` field is populated in the job response.
If the agent edits files successfully, Mintlify creates a pull request and populates the `prLink` field in the job response.

## Rate limits

Expand Down
2 changes: 1 addition & 1 deletion api/agent/v2/get-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Get agent job"
openapi: /admin-openapi.json GET /v2/agent/{projectId}/job/{id}

Check warning on line 3 in api/agent/v2/get-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/get-agent-job.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["agent job", "status", "retrieve", "details", "poll"]

---

Poll this endpoint to track the progress of an agent job. The `status` field transitions through `active` → `completed` or `failed`.

Once the agent creates a pull request, the `prLink` field is populated.
After the agent creates a pull request, the `prLink` field contains the link.
2 changes: 1 addition & 1 deletion api/agent/v2/send-message.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Send follow-up message"
openapi: /admin-openapi.json POST /v2/agent/{projectId}/job/{id}/message

Check warning on line 3 in api/agent/v2/send-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/send-message.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["agent job", "message", "follow-up", "send"]

---

Send a follow-up instruction to an existing agent job. The message is processed asynchronously — poll the [get agent job](/api/agent/v2/get-agent-job) endpoint to track progress.
Send a follow-up instruction to an existing agent job. The agent processes the message asynchronously. Poll the [get agent job](/api/agent/v2/get-agent-job) endpoint to track progress.

## Rate limits

Expand Down
2 changes: 1 addition & 1 deletion api/analytics/assistant-caller-stats.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: "Get assistant caller stats"
openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant/caller-stats

Check warning on line 3 in api/analytics/assistant-caller-stats.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-caller-stats.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "assistant", "caller", "stats", "export"]

---

## Usage

Use this endpoint to see how assistant queries are distributed across different caller types. The response breaks down total queries into:
Use this endpoint to see how the system distributes assistant queries across different caller types. The response breaks down total queries into:

- **web**: Queries from the documentation site
- **api**: Queries from direct API calls

Check warning on line 13 in api/analytics/assistant-caller-stats.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-caller-stats.mdx#L13

Use 'API' instead of 'api'.
- **other**: Queries from other sources (for example, integrations, SDKs)
- **total**: Sum of all query types

Expand Down
2 changes: 1 addition & 1 deletion api/preview/trigger.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Trigger preview deployment"
openapi: "/openapi.json POST /project/preview/{projectId}"

Check warning on line 3 in api/preview/trigger.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/preview/trigger.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["preview", "preview deployment", "branch preview", "staging"]

---
Expand All @@ -15,7 +15,7 @@

## Use cases

- **CI/CD pipelines**: Automatically create preview deployments when pull requests are opened or updated.
- **CI/CD pipelines**: Automatically create preview deployments when users open or update pull requests.
- **Scheduled previews**: Build previews from long-running feature branches on a schedule.
- **Custom tooling**: Integrate preview creation into internal workflows or Slack bots.

Expand Down
2 changes: 1 addition & 1 deletion assistant/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ boost: 3
---

<Info>
The assistant is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=assistant) and is enabled by default for those plans.
The assistant is available on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=assistant) and enabled by default for those plans.
</Info>

## About the assistant
Expand Down
6 changes: 3 additions & 3 deletions components/frames.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Add additional context to an image using the optional `caption` prop. Captions a

### Markdown in captions

Captions support markdown formatting, including links and bold text.
Captions support Markdown formatting, including links and bold text.

<Frame caption="Learn more about [Yosemite National Park](https://www.nps.gov/yose/index.htm) and plan your visit.">
<img src="https://mintlify-assets.b-cdn.net/yosemite.jpg" alt="Photograph of Yosemite Valley." />
Expand All @@ -33,7 +33,7 @@ Captions support markdown formatting, including links and bold text.

## Hints

Add text that precedes the frame using the optional `hint` prop. Hints appear above the frame.
Add text that precedes the frame using the optional `hint` prop. Hints appear before the frame.

<Frame hint="If you plan to visit Yosemite National Park, secure your permits before you go." caption="Yosemite National Park is visited by over 3.5 million people every year.">
<img src="https://mintlify-assets.b-cdn.net/yellowstone.jpeg" alt="Photograph of a lake surrounded by trees with mountains in the distance in Yellowstone National Park." />
Expand All @@ -54,7 +54,7 @@ Videos without `autoPlay` do not have any additional attributes added by default
## Properties

<ResponseField name="caption" type="string">
Text that appears as part of the frame, centered below the content. Supports markdown formatting including links and bold text.
Text that appears as part of the frame, centered below the content. Supports Markdown formatting including links and bold text.
</ResponseField>

<ResponseField name="hint" type="string">
Expand Down
4 changes: 2 additions & 2 deletions components/icons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Use icons from Font Awesome, Lucide, Tabler, SVGs, external URLs, or files in yo

## Inline icons

Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.
Icons appear inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.

```markdown Inline icon example
Icons are placed inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.
Icons appear inline when used within a sentence, paragraph, or heading. <Icon icon="flag" iconType="solid" /> Use icons for decoration or to add visual emphasis.
```

## Properties
Expand Down
2 changes: 1 addition & 1 deletion components/tiles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Combine tiles with the [columns component](/components/columns) to create a resp
## Properties

<ResponseField name="href" type="string" required>
URL to navigate to when the tile is clicked.
URL to navigate to when users click the tile.
</ResponseField>

<ResponseField name="title" type="string">
Expand Down
8 changes: 4 additions & 4 deletions components/view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Use the `View` component to create content that changes based on the selected vi
</Tip>

<View title="JavaScript" icon="js">
This content is only visible when JavaScript is selected.
This content only appears when you select JavaScript.

```javascript
console.log("Hello from JavaScript!");
```
</View>

<View title="Python" icon="python">
This content is only visible when Python is selected.
This content only appears when you select Python.

```python
print("Hello from Python!")
Expand All @@ -31,15 +31,15 @@ Use the `View` component to create content that changes based on the selected vi

````mdx JavaScript and Python views
<View title="JavaScript" icon="js">
This content is only visible when JavaScript is selected.
This content only appears when you select JavaScript.

```javascript
console.log("Hello from JavaScript!");
```
</View>

<View title="Python" icon="python">
This content is only visible when Python is selected.
This content only appears when you select Python.

```python
print("Hello from Python!")
Expand Down
4 changes: 2 additions & 2 deletions components/visibility.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ On your published site, content marked `for="humans"` renders normally and conte
</Visibility>

<Visibility for="agents">
> You are viewing this content **in markdown**.
> You are viewing this content **in Markdown**.
>
> This content only appears on the Markdown version of pages.
>
Expand All @@ -48,7 +48,7 @@ On your published site, content marked `for="humans"` renders normally and conte
</Visibility>

<Visibility for="agents">
> You are viewing this content **in markdown**.
> You are viewing this content **in Markdown**.
>
> This content only appears on the Markdown version of pages.
>
Expand Down
2 changes: 1 addition & 1 deletion create/files.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
- **Video**: `.mp4`, `.webm`
- **Audio**: `.mp3`, `.wav`
- **Data**: `.json`, `.yaml`
- **Stylesheets**: `.css`
- **Stylesheet**: `.css`

Check warning on line 26 in create/files.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/files.mdx#L26

Use 'stylesheets?' instead of 'Stylesheet'.
- **Scripts**: `.js`
- **Fonts**: `.woff`, `.woff2`, `.ttf`, `.eot`

Expand All @@ -49,3 +49,3 @@
|- demo-video.mp4
```

Expand Down
10 changes: 5 additions & 5 deletions customize/custom-domain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,18 @@
</Tip>

<Warning>
If you migrate an existing domain and want zero downtime, add the verification `TXT` records before updating your `CNAME`. Then wait until SSL/TLS certificates pre-provision before cutting over. Switching the `CNAME` before certificates are issued causes HTTPS requests to fail until provisioning completes.
If you migrate an existing domain and want zero downtime, add the verification `TXT` records before updating your `CNAME`. Then wait until SSL/TLS certificates pre-provision before cutting over. Switching the `CNAME` before Mintlify issues certificates causes HTTPS requests to fail until provisioning completes.
</Warning>

### DNS propagation

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 is configured correctly using [DNSChecker](https://dnschecker.org).

Check warning on line 54 in customize/custom-domain.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

customize/custom-domain.mdx#L54

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

Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after your TLS certificate is provisioned.
Once your DNS records are active, your documentation is first accessible via HTTP. HTTPS is available after Mintlify provisions your TLS certificate.

### Automatic TLS provisioning

Once your TXT records are added and your DNS records resolve correctly, a free SSL/TLS certificate is automatically generated for your site using Let's Encrypt.
After you add your `TXT` records and your DNS records resolve correctly, Mintlify generates a free SSL/TLS certificate for your site using Let's Encrypt.

This typically completes within a few hours of DNS propagation, though it can take up to 24 hours in rare cases. Certificates are automatically renewed before expiration.

Expand All @@ -71,13 +71,13 @@

### Reserved paths

The `/.well-known/acme-challenge` path is reserved for certificate validation and cannot be redirected or rewritten. If you have configured redirects or rewrites for this path, certificate provisioning fails.
Mintlify reserves the `/.well-known/acme-challenge` path for certificate validation. You cannot redirect or rewrite this path. If you have configured redirects or rewrites for this path, certificate provisioning fails.

### Provider-specific settings

<AccordionGroup>
<Accordion title="Vercel verification">
If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain, and is emailed to you.
If Vercel is your domain provider, you must add a verification `TXT` record. This information appears on your dashboard after submitting your custom domain, and Mintlify emails it to you.
</Accordion>

<Accordion title="Cloudflare encryption mode">
Expand Down
4 changes: 2 additions & 2 deletions deploy/cloudflare.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
To host your documentation at a subpath such as `yoursite.com/docs` using Cloudflare, you must create and configure a Cloudflare Worker.

<Info>
Before you begin, you need a Cloudflare account and a domain name (can be managed on or off Cloudflare).
Before you begin, you need a Cloudflare account and a domain name (managed on or off Cloudflare).
</Info>

## Set up a worker
Expand Down Expand Up @@ -113,7 +113,7 @@

### Resolve DNS conflicts

If your domain already points to another service, you must remove the existing DNS record. Your Cloudflare Worker must be configured to control all traffic for your domain.
If your domain already points to another service, you must remove the existing DNS record. Your Cloudflare Worker must control all traffic for your domain.

1. Delete the existing DNS record for your domain. See [Delete DNS records](https://developers.cloudflare.com/dns/manage-dns-records/how-to/create-dns-records/#delete-dns-records) in the Cloudflare documentation for more information.
2. Return to your Worker and add your custom domain.
Expand All @@ -122,7 +122,7 @@
If you use Webflow to host your main site and want to serve Mintlify docs at `/docs` on the same domain, you'll need to configure custom routing through Cloudflare Workers to proxy all non-docs traffic to your main site.

<Warning>
Make sure your main site is set up on a landing page before deploying this Worker, or visitors to your main site may see errors.

Check warning on line 125 in deploy/cloudflare.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/cloudflare.mdx#L125

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

1. In Webflow, set up a landing page for your main site like `landing.yoursite.com`. This is the page that visitors see when they visit your site.
Expand Down
2 changes: 1 addition & 1 deletion deploy/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
Go to the [Danger zone](https://dashboard.mintlify.com/settings/organization/danger-zone) in the settings page of your dashboard.
</Step>
<Step title="Delete the deployment.">
1. In the **Delete my deployment** section, provide a reason for deletion.

Check warning on line 38 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L38

Avoid first-person pronouns such as 'my'.
2. Click the delete button and confirm that you want to delete the deployment.
</Step>
</Steps>
Expand All @@ -44,4 +44,4 @@
Deleting a deployment is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period.
</Warning>

If you have multiple deployments, you'll be redirected to another deployment after deletion. If you delete your only deployment, you'll be redirected to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion.
If you have multiple deployments, Mintlify redirects you to another deployment after deletion. If you delete your only deployment, Mintlify redirects you to the Mintlify homepage. When you delete a deployment, the organization admin receives an email notification confirming the deletion.
6 changes: 3 additions & 3 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@
</Accordion>
</AccordionGroup>

After completing either path, install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app).
After completing either path, install the GitHub app by following the steps in [Install the GitHub app](#install-the-github-app).

## Install the GitHub App
## Install the GitHub app

<Note>
You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
Expand Down Expand Up @@ -127,7 +127,7 @@
</Accordion>
</AccordionGroup>

### GitHub App connection issues
### GitHub app connection issues

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

Expand All @@ -144,7 +144,7 @@

### Feedback add-ons are unavailable

The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility.

Check warning on line 147 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L147

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

If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings.

Expand Down
4 changes: 2 additions & 2 deletions deploy/vercel.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Vercel"
description: "Configure Vercel rewrites to serve your Mintlify documentation at a subpath on your main domain with step-by-step vercel.json setup."

Check warning on line 3 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["vercel.json", "Vercel deployment", "rewrites configuration", "subpath routing"]
boost: 3
---
Expand All @@ -9,7 +9,7 @@

Configure your `vercel.json` file to proxy requests from your main domain to your documentation at a subpath.

## vercel.json file

Check warning on line 12 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L12

'vercel.json file' should use sentence-style capitalization.

Check warning on line 12 in deploy/vercel.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/vercel.mdx#L12

Use 'JSON' instead of 'json'.

The `vercel.json` file configures how your project builds and deploys. It sits in your project's root directory and controls various aspects of your deployment, including routing, redirects, headers, and build settings.

Expand All @@ -29,7 +29,7 @@
</Frame>
3. Enter your domain.
4. Select **Add domain**.
5. Add the following rewrites to your `vercel.json` file. Replace `[subdomain]` with your subdomain, which is found at the end of your dashboard URL. For example, `dashboard.mintlify.com/your-organization/your-subdomain` has a domain identifier of `your-subdomain`.
5. Add the following rewrites to your `vercel.json` file. Replace `[subdomain]` with your subdomain, which appears at the end of your dashboard URL. For example, `dashboard.mintlify.com/your-organization/your-subdomain` has a domain identifier of `your-subdomain`.

```json
{
Expand All @@ -56,7 +56,7 @@

### Host at custom subpath

To use a custom subpath (any path other than `/docs`), you must organize your documentation files within your repository to match your subpath structure. For example, if your documentation is hosted at `yoursite.com/help`, your documentation files must be in a `help/` directory.
To use a custom subpath (any path other than `/docs`), you must organize your documentation files within your repository to match your subpath structure. For example, if you host your documentation at `yoursite.com/help`, your documentation files must be in a `help/` directory.

Use the generator below to create your rewrites configuration. Add the rewrites to your `vercel.json` file.

Expand Down
Loading
Loading