diff --git a/agent/index.mdx b/agent/index.mdx index da2f91c3b..5ae88d34e 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -40,6 +40,18 @@ By default, the agent opens pull requests attributed to the Mintlify bot. To att 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. + ## 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. diff --git a/api-playground/overview.mdx b/api-playground/overview.mdx index 3daf5241a..7a20ba831 100644 --- a/api-playground/overview.mdx +++ b/api-playground/overview.mdx @@ -215,6 +215,29 @@ Use the `x-mint` extension so that all of your API documentation generates autom 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. + +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: + +- Your API must accept cross-origin requests from your docs domain. See the [CORS](/api-playground/troubleshooting) section for configuration guidance. +- No Mintlify-side analytics are captured for playground requests. +- 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. diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 44f8bddeb..ccef36d62 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -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.