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
12 changes: 12 additions & 0 deletions agent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,18 @@

The agent can only access repositories that you connect through the Mintlify GitHub App. Configure which repositories the agent can access in the agent panel **Settings** or in the [GitHub App settings](https://github.com/apps/mintlify/installations/new).

## Trigger the agent from a pull request

Mention `@Mintlify` in a comment on any pull request in a connected code repository to open a follow-up pull request on your docs repository with the suggested changes.

Use this to:

- Update the docs when a code PR changes an API, configuration option, or user-facing behavior.
- Ask the agent to review a code diff for documentation impact.
- Draft release notes or changelog entries from the PR's changes.

The agent reads the PR title, description, and diff for context, then opens a separate PR against your docs repository — your code repository is never modified. The Mintlify GitHub App must be installed on both the code repository and the docs repository.

Check warning on line 53 in agent/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/index.mdx#L53

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

Check warning on line 53 in agent/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/index.mdx#L53

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

## Use AI tools alongside the agent

The agent works asynchronously through pull requests, but you can also use AI coding tools like Cursor or Claude Code locally for fast, iterative edits. Install the Mintlify [skill](/ai/skillmd) and connect the [MCP server](/ai/model-context-protocol) so your editor has the same context the agent uses.
Expand Down
23 changes: 23 additions & 0 deletions api-playground/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,29 @@

Use individual MDX pages for small APIs or when you want to experiment with changes on a per-page basis.

## Request proxy and logging

By default, playground requests are routed through Mintlify's proxy at `/_mintlify/api/request` on your docs site to handle CORS. The proxy forwards your request to your API and returns the response to the browser.

Check warning on line 220 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L220

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

Check warning on line 220 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L220

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

Mintlify captures lightweight metadata about each proxied request for analytics and debugging: the endpoint path, HTTP method, and response status. Request bodies, headers with credentials, and response bodies are not stored.

To bypass the proxy and send requests directly from the browser to your API, set `api.playground.proxy` to `false` in your `docs.json`. When the proxy is disabled:

Check warning on line 224 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L224

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

- Your API must accept cross-origin requests from your docs domain. See the [CORS](/api-playground/troubleshooting) section for configuration guidance.

Check warning on line 226 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L226

Spell out 'CORS', if it's unfamiliar to the audience.
- No Mintlify-side analytics are captured for playground requests.

Check warning on line 227 in api-playground/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/overview.mdx#L227

In general, use active voice instead of passive voice ('are captured').
- Set `api.playground.credentials` to `true` if your API relies on cookies or session tokens.

```json
{
"api": {
"playground": {
"proxy": false,
"credentials": true
}
}
}
```

## Response rendering

The playground automatically renders responses based on the `Content-Type` header returned by your API.
Expand Down
49 changes: 49 additions & 0 deletions organize/navigation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -453,6 +453,55 @@ In the `navigation` object, `products` is an array where each entry is an object
}
```

### Product menus

Add a `menu` array to a product to turn the product switcher into a multi-column panel. Each menu item can group related products or link to external resources, giving readers a richer entry point than a flat list.

Menu items can contain groups, pages, and external links.

```json
{
"navigation": {
"products": [
{
"product": "Platform",
"icon": "server",
"menu": [
{
"item": "APIs",
"icon": "code",
"description": "REST and GraphQL APIs for the Platform product.",
"groups": [
{
"group": "Core APIs",
"pages": [
"platform/api/users",
"platform/api/projects"
]
}
]
},
{
"item": "SDKs",
"icon": "box",
"description": "Client libraries for popular languages.",
"pages": [
"platform/sdk/node",
"platform/sdk/python"
]
},
{
"item": "Changelog",
"icon": "list",
"href": "https://example.com/changelog"
}
]
}
]
}
}
```

## Dropdowns

Dropdowns are an expandable menu at the top of your sidebar navigation. Each item in a dropdown directs to a section of your documentation.
Expand Down
Loading