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
2 changes: 1 addition & 1 deletion advanced-support.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Mintlify will use commercially reasonable efforts to meet the following service

<AccordionGroup>
<Accordion title="What counts as a P0 incident?">
A P0 is a complete service outage or security incident affecting your Mintlify deployment. Mintlify determines P0 classification. We monitor our systems continuously and proactively open P0 incidents when our criteria match. Real-time status is always available at [status.mintlify.com](https://status.mintlify.com).
A P0 is a complete service outage or security incident affecting your Mintlify project. Mintlify determines P0 classification. We monitor our systems continuously and proactively open P0 incidents when our criteria match. Real-time status is always available at [status.mintlify.com](https://status.mintlify.com).
</Accordion>

<Accordion title="What are Mintlify business hours?">
Expand Down
8 changes: 4 additions & 4 deletions agent-context/context/skills/mintlify/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,24 @@ Tools:

Write access to a Mintlify project. Requires OAuth on first use. Complete authentication in the browser when prompted.

Use this server when the user wants to edit their Mintlify content, restructure navigation, or open a pull request. Content changes buffer on a session branch; nothing touches the deploy branch until `save`. Deployment management changes made through code mode apply immediately to the live deployment without a branch or pull request.
Use this server when the user wants to edit their Mintlify content, restructure navigation, or open a pull request. Content changes buffer on a session branch; nothing touches the deploy branch until `save`. Project management changes made through code mode apply immediately to the live project without a branch or pull request.

Workflow: call `checkout` first (always), then use `read`/`search`/`edit_page`/`write_page`/`list_nodes`/`create_node`/`update_node`/`move_node`/`delete_node`/`update_config` to make changes, then call `save` to publish (or `discard_session` to abandon).

Key tools:
- **`checkout`** — Start a session on a branch (required first call). Returns an `editorUrl` to preview changes live.
- **`list_branches`** — List existing branches; call before `checkout` to attach to one.
- **`list_deployments`** — Discover which deployment(s) this connection can access.
- **`list_deployments`** — Discover which project(s) this connection can access.
- **`read`** / **`search`** — Fetch a page's MDX or search across pages.
- **`edit_page`** / **`write_page`** — Apply targeted edits or overwrite a page.
- **`list_nodes`** / **`create_node`** / **`update_node`** / **`move_node`** / **`delete_node`** — Manage the navigation tree.
- **`update_config`** — Modify `docs.json` (theme, nav roots, integrations, SEO).
- **`search_code_operations`** / **`execute_code`** — Code mode for deployment-level operations with no dedicated tool (workflows, settings, members, billing, integrations, analytics, private-page sharing). Search available methods, then run a TypeScript script against them. No `checkout` required. Writes apply immediately to the live deployment, so confirm the intended change first.
- **`search_code_operations`** / **`execute_code`** — Code mode for project-level operations with no dedicated tool (workflows, settings, members, billing, integrations, analytics, private-page sharing). Search available methods, then run a TypeScript script against them. No `checkout` required. Writes apply immediately to the live project, so confirm the intended change first.

Private pages: `list_nodes` accepts `visibility: "private"` to list the private pages and folders the OAuth user can access (ignores other filters, returns each node's `role`). `read`, `edit_page`, `write_page`, `update_node`, and `delete_node` accept `private-page-<uuid>` or `private-folder-<uuid>` node ids; `create_node` accepts `visibility: "private"` with `data.type: "page"` or `"group"`. Private-page operations require an OAuth session (the admin MCP rejects client and machine-to-machine tokens), work without a `checkout`, and enforce role requirements: read for reads, editor or higher for writes and updates, manager for deletes. The caller becomes the manager of any node they create.
- **`diff`** — See all changes relative to the deploy branch.
- **`get_session_state`** — Check the current session's status.
- **`save`** — Publish the session. `mode: "auto"` (default) opens a PR, and Mintlify merges it immediately when the deployment's publishing setting allows direct pushes and the deploy branch isn't protected. `mode: "pr"` always opens a PR and leaves it open for review. `mode: "commit"` pushes to an existing PR branch without opening a new PR. Changing the publishing setting in the dashboard requires the admin role.
- **`save`** — Publish the session. `mode: "auto"` (default) opens a PR, and Mintlify merges it immediately when the project's publishing setting allows direct pushes and the deploy branch isn't protected. `mode: "pr"` always opens a PR and leaves it open for review. `mode: "commit"` pushes to an existing PR branch without opening a new PR. Changing the publishing setting in the dashboard requires the admin role.
- **`discard_session`** — Drop all in-session changes.

Keep each session focused on one change. Smaller sessions produce easier-to-review PRs. Open the `editorUrl` to watch changes render live.
Expand Down
2 changes: 1 addition & 1 deletion agent-context/context/skills/mintlify/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Available on all commands.
- `mint logout` — Log out of your account.
- `mint status` — Show current authentication status (CLI version, email, org, subdomain).
- `mint signup [flags]` — Create a new Mintlify account from the terminal. Flags: `--firstName`, `--lastName`, `--company`, `--email`; omit any to enter it interactively. Waits until you click the emailed verification link before it logs you in — run as a background process in scripts.
- `mint add-domain <domain> [--basePath <path>]` — Add a custom domain to the current deployment. Requires `mint login`. Pass `--basePath` to serve the documentation from a subpath such as `/docs`.
- `mint add-domain <domain> [--basePath <path>]` — Add a custom domain to the current project. Requires `mint login`. Pass `--basePath` to serve the documentation from a subpath such as `/docs`.

## Analytics

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The `docs.json` file controls the entire site. Required fields: `theme`, `name`,

### Splitting configuration with `$ref`

Use `$ref` at any level of `docs.json` to load configuration from another JSON file. Useful for splitting large configs or sharing navigation across deployments.
Use `$ref` at any level of `docs.json` to load configuration from another JSON file. Useful for splitting large configs or sharing navigation across projects.

```json
{
Expand Down Expand Up @@ -372,7 +372,7 @@ The current API version is {{apiVersion}}.

Shows "Last modified on [date]" on all pages. Override per-page with `timestamp` frontmatter.

Date precedence: (1) the page's `lastUpdatedDate` frontmatter, (2) the date of the last Git commit that modified the page (GitHub/GitLab deployments), (3) the most recent deployment timestamp. Set `lastUpdatedDate` when Git history doesn't reflect when content changed (e.g., imported or synced content).
Date precedence: (1) the page's `lastUpdatedDate` frontmatter, (2) the date of the last Git commit that modified the page (GitHub/GitLab projects), (3) the most recent deployment timestamp. Set `lastUpdatedDate` when Git history doesn't reflect when content changed (e.g., imported or synced content).

## Interaction

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ Version properties:

Each language entry can include its own `banner`, `footer`, and `navbar` configuration overrides.

To redirect visitors from the site root to the language matching their browser's `Accept-Language` header, enable **Auto-route to preferred language** on the dashboard Add-ons page (`https://app.mintlify.com/settings/project/addons`). Mintlify only redirects visits to the site root. If a visitor picks a language with the language switcher, Mintlify remembers their choice and stops auto-routing them. If no published language matches the visitor's browser preferences, Mintlify serves the default language.
To redirect visitors from the site root to the language matching their browser's `Accept-Language` header, enable **Auto-route by language** in the **Language routing** section of the dashboard General settings page (`https://app.mintlify.com/settings/project/general`). Mintlify only redirects visits to the site root. If a visitor picks a language with the language switcher, Mintlify remembers their choice and stops auto-routing them. If no published language matches the visitor's browser preferences, Mintlify serves the default language.

## OpenAPI in navigation

Expand Down
6 changes: 3 additions & 3 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ By default, the agent opens pull requests attributed to the Mintlify bot. To att

## Choose how the agent publishes changes

By default, the agent opens a pull request for every change so your team can review it before it ships. If Mintlify hosts your deployment, the agent commits changes directly to your deployment branch so changes publish immediately.
By default, the agent opens a pull request for every change so your team can review it before it ships. If Mintlify hosts your project, the agent commits changes directly to your deployment branch so changes publish immediately.

For deployments connected to your own Git provider, click **Configure Slack** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard, then set **Review process** in Slack settings:
For projects connected to your own Git provider, click **Configure Slack** on the [Automations](https://app.mintlify.com/products/automations) page of your dashboard, then set **Review process** in Slack settings:

- **Create a pull request**: The agent commits to a new branch and opens a pull request against your deploy branch. Use this option when you want a human to review changes before they publish.
- **Push to main**: The agent commits directly to your deploy branch, and changes publish as soon as the agent finishes. Use this option when you trust the agent to publish without review, for example on a staging deployment.
Expand All @@ -62,7 +62,7 @@ The agent can only access repositories that you connect through the Mintlify Git

If your Git provider restricts access with an IP allowlist, Mintlify can route Git requests from agent sandboxes through a static IP address.

Contact Mintlify about the deployment that you want to enable static agent egress for. Once enabled, the static address applies to Git operations from the agent and automations, including cloning, fetching, and pushing connected repositories.
Contact Mintlify about the project that you want to enable static agent egress for. Once enabled, the static address applies to Git operations from the agent and automations, including cloning, fetching, and pushing connected repositories.

<Note>
Static agent egress applies only to Git requests from agent sandboxes. Other outbound requests do not use this static IP address.
Expand Down
14 changes: 5 additions & 9 deletions agent/slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
<Note>
Each Slack workspace can connect to only one Mintlify organization at a time. If you try to install the agent into a workspace that is already connected to a different organization, the installation fails with a "wrong organization" error. Uninstall the app from the other organization first, or use a different Slack workspace.

You can install the Slack agent even if you don't have a Mintlify-hosted deployment. The agent still works for question answering and conversations. Features that open pull requests require a connected repository.
You can install the Slack agent even if you don't have a Mintlify-hosted project. The agent still works for question answering and conversations. Features that open pull requests require a connected repository.
</Note>

1. Navigate to the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
Expand All @@ -37,7 +37,7 @@
</Warning>

<Note>
The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) deployments.
The Slack agent is not available for [Bitbucket Cloud](/deploy/bitbucket) projects.

If your Git provider is behind an IP allowlist, allow the Mintlify egress IP `54.242.90.151` so the agent can clone your repository. Contact support to opt in.
</Note>
Expand All @@ -61,15 +61,11 @@
When you reinstall the agent into a workspace that is already connected to your organization, Mintlify refreshes the stored bot token in place. Your existing channels and threads remain intact.

<Tip>
If your organization has multiple deployments, the agent asks you to select which deployment to work with the first time you send a request.
If your organization has multiple projects, the agent asks you to select which project to work with the first time you send a request.

Your preferred deployment is personal to your Slack account and does not affect
other team members. You can switch to a different deployment at any time during a
conversation by clicking the **Switch deployment** button on the agent's status
message in the thread. The agent retains your conversation history so you can
continue where you left off with the new deployment.
Your preferred project is personal to your Slack account and does not affect other team members. To switch to a different project at any time during a conversation, click **Switch** next to the project name on the agent's status message in the thread. The agent retains your conversation history so you can continue where you left off in the project that you switch to.

You can also share a link to a pull request in any connected deployment. The agent switches to that deployment automatically and continues the PR.
If you share a link to a pull request in any connected project, the agent switches to that project automatically and continues the working on the branch that the pull request targets.
</Tip>

## Use the agent in Slack
Expand Down Expand Up @@ -151,7 +147,7 @@

You can also ask the agent about automation activity, such as recent runs, failures, or credit use.

- "How can I make my automations more credit efficient?"

Check warning on line 150 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L150

Avoid first-person pronouns such as ' I '.

Check warning on line 150 in agent/slack.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/slack.mdx#L150

Avoid first-person pronouns such as 'my'.
- "Why did the last run of the code change automation fail?"

### Trigger automations from Slack messages
Expand Down
14 changes: 7 additions & 7 deletions ai/bring-your-own-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ keywords: ["BYOK", "key", "OpenRouter", "Anthropic", "OpenAI", "LLM", "API key",

By default, Mintlify selects the models that power the assistant and agent. To use a specific model with your own provider account, supply an API key and choose the model. Mintlify then runs inference against your provider.

One configuration covers every AI product on a deployment: the [assistant](/assistant), [agent](/agent), and [automations](/automations/index).
One configuration covers every AI product on a project: the [assistant](/assistant), [agent](/agent), and [automations](/automations/index).

Bring your own model applies to a single deployment, not to your whole organization. If your organization has more than one deployment, configure each one separately. Deployments you don't configure use Mintlify's default models.
Bring your own model applies to a single project, not to your whole organization. If your organization has more than one project, configure each one separately. Projects you don't configure use Mintlify's default models.

## Supported providers

Expand All @@ -28,7 +28,7 @@ Each provider supports a fixed set of models.

[Editors and admins](/dashboard/roles) can configure the model.

1. Select the deployment you want to configure.
1. Select the project you want to configure.
2. Navigate to the [API keys](https://app.mintlify.com/settings/organization/api-keys) page in your dashboard.
3. In the **AI model** section, enable **Bring your own model**.
4. Select a provider. For an OpenAI-compatible provider, enter a provider name and base URL. The base URL must use HTTPS and point to a publicly reachable host.
Expand All @@ -40,14 +40,14 @@ Mintlify stores your key encrypted and never displays it again after you save it

## How credits work

AI usage on a deployment with bring your own model enabled does not consume Mintlify [credits](/credits). Your provider bills you directly for inference, and those charges do not appear in your Mintlify usage. Set any spending limits with your provider.
AI usage on a project with bring your own model enabled does not consume Mintlify [credits](/credits). Your provider bills you directly for inference, and those charges do not appear in your Mintlify usage. Set any spending limits with your provider.

Credits pool at the organization level. Other deployments in the same organization still draw from that shared balance at the standard rate for their AI usage.
Credits pool at the organization level. Other projects in the same organization still draw from that shared balance at the standard rate for their AI usage.

## Rotate or remove your key

Mintlify reuses your saved key across models for the same provider on that deployment. Enter a key again only when you rotate it, switch providers, or configure another deployment.
Mintlify reuses your saved key across models for the same provider on that project. Enter a key again only when you rotate it, switch providers, or configure another project.

To rotate your key, enter the new key in the **API key** field, then click **Save**.

To stop using your own model, disable **Bring your own model**. Mintlify deletes the stored configuration and key for that deployment, and its AI products return to Mintlify's default models. AI usage on the deployment then consumes credits at the standard rate. Other deployments keep their own configurations.
To stop using your own model, disable **Bring your own model**. Mintlify deletes the stored configuration and key for that project, and its AI products return to Mintlify's default models. AI usage on the project then consumes credits at the standard rate. Other projects keep their own configurations.
2 changes: 1 addition & 1 deletion ai/contextual-menu.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The contextual menu includes several pre-built options that you can enable by ad
| **Connect to Cursor** | `cursor` | Installs your hosted MCP server in Cursor |
| **Connect to VS Code** | `vscode` | Installs your hosted MCP server in VS Code |
| **Connect to Devin** | `devin-mcp` | Installs your hosted MCP server in Devin |
| **Download API spec** | `download-spec` | Downloads your deployment's OpenAPI spec. If there are multiple specs, downloads them as a zip archive. Only appears on API reference pages. |
| **Download API spec** | `download-spec` | Downloads your project's OpenAPI spec. If there are multiple specs, downloads them as a zip archive. Only appears on API reference pages. |
| **Custom options** | Object | Add custom options to the contextual menu |

## Enable the contextual menu
Expand Down
Loading
Loading