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
14 changes: 7 additions & 7 deletions admin-openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"schema": {
"type": "string"
},
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
}
],
"requestBody": {
Expand Down Expand Up @@ -126,7 +126,7 @@
"schema": {
"type": "string"
},
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
},
{
"name": "id",
Expand Down Expand Up @@ -237,7 +237,7 @@
"schema": {
"type": "string"
},
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
},
{
"name": "skip",
Expand Down Expand Up @@ -370,7 +370,7 @@
"schema": {
"type": "string"
},
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
}
],
"requestBody": {
Expand Down Expand Up @@ -437,7 +437,7 @@
"schema": {
"type": "string"
},
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
},
{
"name": "id",
Expand Down Expand Up @@ -485,7 +485,7 @@
"schema": {
"type": "string"
},
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
},
{
"name": "id",
Expand Down Expand Up @@ -627,7 +627,7 @@
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "The Authorization header expects a Bearer token. Use an admin API key (prefixed with `mint_`). This is a server-side secret key. Generate one on the [API keys page](https://dashboard.mintlify.com/settings/organization/api-keys) in your dashboard."
"description": "The Authorization header expects a Bearer token. Use an admin API key (prefixed with `mint_`). This is a server-side secret key. Generate one on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard."
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion agent/effective-prompts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Use broad prompts for general content maintenance like fixing typos, updating re

If you have multiple documentation sites, include the `subdomain` parameter in your message to specify which documentation set the agent should work on.

To find your domain name, look at your dashboard URL for the documentation set you want to update. The domain name is the last part after your organization name. For example, if your dashboard URL is `https://dashboard.mintlify.com/org-name/domain-name`, your domain name is `domain-name`.
To find your domain name, look at your dashboard URL for the documentation set you want to update. The domain name is the last part after your organization name. For example, if your dashboard URL is `https://app.mintlify.com/org-name/domain-name`, your domain name is `domain-name`.

Use the format `@mintlify subdomain=<your-domain-name> <your-prompt>` to prompt the agent to work on a specific documentation set.

Expand Down
2 changes: 1 addition & 1 deletion agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Use the agent to:

## Connect your GitHub account

By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://dashboard.mintlify.com/settings/account) page of the dashboard.
By default, the agent opens pull requests attributed to the Mintlify bot. To attribute pull requests to you, connect your GitHub account on the [My profile](https://app.mintlify.com/settings/account) page of the dashboard.

## Connect repositories as context

Expand Down
8 changes: 4 additions & 4 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Connect your Slack workspace

1. Go to the [Agent](https://dashboard.mintlify.com/products/agent) page in your dashboard.
1. Go to the [Agent](https://app.mintlify.com/products/agent) page in your dashboard.
2. In the "Agent settings" section, click **Install Slack app**.
<Frame>
<img src="/images/agent/install-apps-light.png" alt="The App settings section with the Slack and Notion install buttons." className="block dark:hidden" />
Expand Down Expand Up @@ -44,7 +44,7 @@

## Connect additional integrations from Slack

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 47 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L47

Did you really mean 'CRMs'?

<Note>
You must configure GitHub and GitLab through Mintlify, not Composio. Use the [GitHub app](/deploy/github) or [GitLab integration](/deploy/gitlab) to control which repositories the agent can access.
Expand All @@ -60,15 +60,15 @@
3. Click the link, sign in to the third-party service, and approve the requested permissions. After you authorize, your browser displays a confirmation page indicating that the connection is complete.
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 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.
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://app.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.
To remove or reauthorize an organization-level integration, use the **Agent settings** section of the [Agent](https://app.mintlify.com/products/agent) page.

For the full list of supported services, see the [Composio toolkits catalog](https://docs.composio.dev/toolkits).

### Expired or revoked connections

Mintlify keeps the status of your connected services in sync with Composio. A connection is disconnected when:

Check warning on line 71 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L71

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

- The third-party provider expires or revokes the credentials.
- The provider marks the connection as inactive.
Expand All @@ -83,7 +83,7 @@
- Send direct messages to the agent to use it privately.
- Mention `@mintlify` in a channel to use it publicly and collaboratively.
- Attach files and images directly to your messages for the agent to process and include in your docs.
- Continue conversations in threads to iterate on changes or ask follow-up questions. The agent reuses files and images shared earlier in the thread as context for follow-up requests, so you don't have to reupload them.

Check warning on line 86 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L86

Did you really mean 'reupload'?
- Share pull request links with the agent to update related documentation.

## Ask questions about your docs
Expand All @@ -95,7 +95,7 @@

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

Check warning on line 98 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L98

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

## Update documentation
Expand All @@ -104,7 +104,7 @@

- **New request**: Send a direct message to the agent or mention `@mintlify` in a channel with instructions on what to update.
- **Existing thread**: Reply in the thread and mention `@mintlify` with instructions on what to update.
- **With attachments**: Upload images, diagrams, code files, or other documents with your message. The agent automatically processes and includes them in your documentation. In a thread, the agent has access to images and files shared in earlier messages, so you can reference them in follow-up requests without reuploading.

Check warning on line 107 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L107

Did you really mean 'reuploading'?

The agent reads the context of the request or thread and creates a pull request in your connected repository with the updates.

Expand Down Expand Up @@ -140,7 +140,7 @@
- **Admins and editors**: Can ask questions and make documentation changes. The agent has access to file editing and pull request tools.
- **Viewers**: Can ask questions only. The agent runs in read-only mode for Mintlify tools and third-party integrations.

To change a teammate's permissions, update their role on the [Members](https://dashboard.mintlify.com/settings/organization/members) page of your dashboard.
To change a teammate's permissions, update their role on the [Members](https://app.mintlify.com/settings/organization/members) page of your dashboard.

## Best practices

Expand Down
16 changes: 8 additions & 8 deletions ai/model-context-protocol.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Mintlify generates an MCP server for your documentation and hosts it at the `/mc
* For documentation with partial authentication, where some pages are public and others require login, you must enable your MCP server before users can access it. Unauthenticated users can search public content. Users who authenticate can search all content they have permission to access based on their [user groups](/deploy/authentication-setup).
* For documentation where all pages require authentication, you must enable your MCP server before it is available to users. Users must authenticate before connecting to your MCP server. Your MCP server searches only the content each user has access to based on their [user groups](/deploy/authentication-setup).

View and copy your MCP server URL on the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.
View and copy your MCP server URL on the [MCP server page](https://app.mintlify.com/products/mcp) in your dashboard.

<Frame>
<img src="/images/mcp/mcp-server-page-light.png" alt="MCP server page in the dashboard." className="block dark:hidden" />
Expand Down Expand Up @@ -131,7 +131,7 @@ By default, your MCP server is only available for localhost tools. To allow web-

<Steps>
<Step title="Enable authenticated MCP in your dashboard">
1. Navigate to the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.
1. Navigate to the [MCP server page](https://app.mintlify.com/products/mcp) in your dashboard.
2. Click the **Enable MCP Server** toggle.
</Step>
<Step title="Add redirect domains">
Expand All @@ -151,7 +151,7 @@ Client credentials authenticate against the `/authed/mcp` endpoint and return al

<Steps>
<Step title="Create a client credential">
1. Navigate to the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.
1. Navigate to the [MCP server page](https://app.mintlify.com/products/mcp) in your dashboard.
2. In the **Client Credentials** section, click **Create credential**.
3. Enter a label for the credential to identify its purpose.
4. Copy the **client ID** and **client secret**. The client secret is only shown once. You cannot retrieve it later.
Expand Down Expand Up @@ -220,7 +220,7 @@ Client credentials authenticate against the `/authed/mcp` endpoint and return al

#### Managing client credentials

You can manage your client credentials from the [MCP server page](https://dashboard.mintlify.com/products/mcp) in your dashboard.
You can manage your client credentials from the [MCP server page](https://app.mintlify.com/products/mcp) in your dashboard.

- **Delete a credential** to permanently revoke access. This cannot be undone.

Expand Down Expand Up @@ -298,7 +298,7 @@ These are some of the ways you can help your users connect to your MCP server:
<Tab title="Claude">
<Steps>
<Step title="Get your MCP server URL.">
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
Navigate to your [dashboard](https://app.mintlify.com/products/mcp) and find your MCP server URL.
</Step>
<Step title="Publish your MCP server URL for your users.">
Create a guide for your users that includes your MCP server URL and the steps to connect it to Claude.
Expand All @@ -317,7 +317,7 @@ See the [Model Context Protocol documentation](https://modelcontextprotocol.io/d
<Tab title="Claude Code">
<Steps>
<Step title="Get your MCP server URL.">
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
Navigate to your [dashboard](https://app.mintlify.com/products/mcp) and find your MCP server URL.
</Step>
<Step title="Publish your MCP server URL for your users.">
Create a guide for your users that includes your MCP server URL and the command to connect it to Claude Code.
Expand All @@ -333,7 +333,7 @@ See the [Claude Code documentation](https://docs.anthropic.com/en/docs/claude-co
<Tab title="Cursor">
<Steps>
<Step title="Get your MCP server URL.">
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
Navigate to your [dashboard](https://app.mintlify.com/products/mcp) and find your MCP server URL.
</Step>
<Step title="Publish your MCP server URL for your users.">
Create a guide for your users that includes your MCP server URL and the steps to connect it to Cursor.
Expand All @@ -360,7 +360,7 @@ See the [Cursor documentation](https://docs.cursor.com/en/context/mcp#installing
<Tab title="VS Code">
<Steps>
<Step title="Get your MCP server URL.">
Navigate to your [dashboard](https://dashboard.mintlify.com/products/mcp) and find your MCP server URL.
Navigate to your [dashboard](https://app.mintlify.com/products/mcp) and find your MCP server URL.
</Step>
<Step title="Publish your MCP server URL for your users.">
Create a guide for your users that includes your MCP server URL and the steps to connect it to VS Code.
Expand Down
4 changes: 2 additions & 2 deletions analytics.openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "The Authorization header expects a Bearer token. Use an admin API key (prefixed with `mint_`). This is a server-side secret key. Generate one on the [API keys page](https://dashboard.mintlify.com/settings/organization/api-keys) in your dashboard."
"description": "The Authorization header expects a Bearer token. Use an admin API key (prefixed with `mint_`). This is a server-side secret key. Generate one on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard."
}
},
"schemas": {
"projectId": {
"type": "string",
"description": "Your project ID. Can be copied from the [API keys](https://dashboard.mintlify.com/settings/organization/api-keys) page in your dashboard."
"description": "Your project ID. Can be copied from the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard."
},
"FeedbackResponse": {
"type": "object",
Expand Down
2 changes: 1 addition & 1 deletion api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The Mintlify REST (Representational State Transfer) API enables you to programmatically interact with your documentation, trigger updates, embed AI-powered chat experiences, and export analytics data.

## Endpoints

Check warning on line 10 in api/introduction.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/introduction.mdx#L10

Use 'endpoints?' instead of 'Endpoints'.

- [Trigger update](/api/update/trigger): Trigger an update of your site when desired.
- [Get update status](/api/update/status): Get the status of an update and other details about your docs.
Expand Down Expand Up @@ -37,7 +37,7 @@

## Authentication

Generate API keys on the [API keys page](https://dashboard.mintlify.com/settings/organization/api-keys) in your dashboard. Each API key belongs to an organization--you can use keys across multiple deployments within the same organization.
Generate API keys on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Each API key belongs to an organization--you can use keys across multiple deployments within the same organization.

You can create up to 10 API keys per hour per organization.

Expand Down
10 changes: 5 additions & 5 deletions assistant/configure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["assistant", "settings", "deflection", "bot protection", "billing"]
---

Configure the assistant on the [Assistant](https://dashboard.mintlify.com/products/assistant) page of your dashboard. Manage billing and usage on the [Usage](https://dashboard.mintlify.com/settings/organization/usage) page.
Configure the assistant on the [Assistant](https://app.mintlify.com/products/assistant) page of your dashboard. Manage billing and usage on the [Usage](https://app.mintlify.com/settings/organization/usage) page.

## Enable or disable the assistant

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

To enable bot protection:

1. Go to the [Assistant settings](https://dashboard.mintlify.com/products/assistant/settings) page in your dashboard.
1. Go to the [Assistant settings](https://app.mintlify.com/products/assistant/settings) page in your dashboard.
2. In the **Bot Protection** section, toggle **Invisible Captcha** on.

Changes take up to 10 minutes to propagate.
Expand All @@ -83,25 +83,25 @@

If you have unused credits at the end of the month, up to half of your credit allowance can carry over to the next billing cycle. For example, if you have a 1,000 credit allowance and you use 300 credits, 500 credits carry over to the next billing cycle giving you a total of 1,500 credits for the next billing cycle.

By default, overages are disabled. With overages disabled, the assistant is unavailable once you reach your credit allowance and remains unavailable until your allowance resets. You can enable overages to keep the assistant available beyond your package allowance. If you enable overages, each credit beyond your allowance incurs an overage charge, but occasional overages may be cheaper than upgrading to a higher package depending on your usage.

Check warning on line 86 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L86

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

### Enable the assistant on the Hobby plan

If you're on the Hobby plan, you can add the assistant to your site by purchasing a credit package without upgrading to Pro. The assistant is enabled as soon as your purchase completes and remains active for as long as you have an active credit package.

Check warning on line 90 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L90

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

To purchase a credit package on the Hobby plan:

1. Go to the [Usage](https://dashboard.mintlify.com/settings/organization/usage) page of your dashboard.
1. Go to the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard.
2. In the **Credit packages** section, select a package from the dropdown menu.
3. Confirm the change to be redirected to checkout.

Check warning on line 96 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L96

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

To stop the assistant, downgrade your credit package to the lowest tier. Your plan returns to Hobby and the assistant is disabled at the end of the current billing cycle.

Check warning on line 98 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L98

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

### Change your assistant package

Packages determine your monthly credit allowance and pricing.

View and change your current package on the [Usage](https://dashboard.mintlify.com/settings/organization/usage) page of your dashboard. You can also reach the Usage page by selecting **View usage** next to **Billing portal** on the Billing page.
View and change your current package on the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard. You can also reach the Usage page by selecting **View usage** next to **Billing portal** on the Billing page.

In the **Credit packages** section, select your preferred package from the dropdown menu.

Expand All @@ -116,7 +116,7 @@

### Allow overages

Overages are disabled by default. To allow overages, enable them in the **Billing controls** section of the [Usage](https://dashboard.mintlify.com/settings/organization/usage) page of your dashboard.
Overages are disabled by default. To allow overages, enable them in the **Billing controls** section of the [Usage](https://app.mintlify.com/settings/organization/usage) page of your dashboard.

Check warning on line 119 in assistant/configure.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/configure.mdx#L119

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

### Set usage alerts

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

<Info>
The assistant is included on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=assistant) and enabled by default for those plans. Hobby plan users can [purchase a credit package](/assistant/configure#manage-billing) to add the assistant to their site.

Check warning on line 9 in assistant/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/index.mdx#L9

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

## About the assistant
Expand Down Expand Up @@ -38,7 +38,7 @@

Use assistant insights to understand how users interact with your documentation and identify improvement opportunities.

The [assistant page](https://dashboard.mintlify.com/products/assistant) shows usage trends for the month to date. View more detailed insights on the [analytics](/optimize/analytics#assistant) page.
The [assistant page](https://app.mintlify.com/products/assistant) shows usage trends for the month to date. View more detailed insights on the [analytics](/optimize/analytics#assistant) page.

## Make content AI ingestible

Expand Down
Loading
Loading