From 2130790c4cc9f157fb2ff2e84b8647dcfceef550 Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Fri, 19 Dec 2025 14:16:24 -0800 Subject: [PATCH 1/4] Update ai/agent.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- ai/agent.mdx | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/ai/agent.mdx b/ai/agent.mdx index 04a362618..75b9301b3 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -52,6 +52,28 @@ Use the agent in Slack to collaborate with your team on documentation updates. - Send a direct message to it. - Mention it with `@mintlify` in a channel. +## Use the agent in GitHub pull requests + +Mention `@mintlify` in comments on any GitHub pull request to create documentation updates in your docs repository. The agent uses AI to automatically select the correct documentation deployment when you have multiple sites, so you don't need to specify a subdomain in most cases. + + + The GitHub App must be installed and configured for the agent to respond to PR comments. See [GitHub integration](/deploy/github) for setup instructions. + + +When you mention `@mintlify` in a PR comment: + +1. The agent analyzes your comment and the PR context +1. It automatically selects the appropriate documentation deployment +1. It creates or updates a documentation PR with the requested changes +1. It links back to the original PR with the documentation changes + +You can mention `@mintlify` in: +- PR comments +- PR review comments on specific lines of code +- PR review summaries + +The agent maintains context across multiple comments in the same PR thread, allowing you to iterate on documentation changes just like in Slack. + ## 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. From 8e666a49741f6b5053698473e0a468016dfe287e Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Fri, 19 Dec 2025 14:16:35 -0800 Subject: [PATCH 2/4] Update ai/agent.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- ai/agent.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/ai/agent.mdx b/ai/agent.mdx index 75b9301b3..1a33dd223 100644 --- a/ai/agent.mdx +++ b/ai/agent.mdx @@ -140,7 +140,9 @@ Use broad prompts for general content maintenance like fixing typos, updating re ## Specify a domain name -If you have multiple documentation sites, include the `subdomain` parameter in your message to specify which documentation set the agent should work on. +If you have multiple documentation sites, the agent uses AI to automatically select the appropriate deployment based on your message context. In most cases, you don't need to manually specify which documentation set to update. + +If you need to explicitly specify a documentation site, include the `subdomain` parameter in your message. 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`. From 5987babaf94e08dcf742194880dc2631545aa2c3 Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Fri, 19 Dec 2025 14:16:41 -0800 Subject: [PATCH 3/4] Update deploy/github.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- deploy/github.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/deploy/github.mdx b/deploy/github.mdx index 1aa7a99a1..d26787f28 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -4,7 +4,7 @@ description: "Connect to a GitHub repository for automated deployments, pull req keywords: ["GitHub App", "repository connection", "automated deployments"] --- -Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository. +Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository. The GitHub App also enables the agent to respond to `@mintlify` mentions in pull request comments across any of your repositories. **Do you need the GitHub App?** From 1b0862999505b907c9ca8ccfee51e8dc049f368e Mon Sep 17 00:00:00 2001 From: Han Wang <44352119+handotdev@users.noreply.github.com> Date: Fri, 19 Dec 2025 14:16:48 -0800 Subject: [PATCH 4/4] Update deploy/github.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- deploy/github.mdx | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/deploy/github.mdx b/deploy/github.mdx index d26787f28..d6a608bc2 100644 --- a/deploy/github.mdx +++ b/deploy/github.mdx @@ -52,7 +52,12 @@ The app only accesses repositories that you explicitly grant it access to. If yo ## Manage repository access -When installing the GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to your documentation repository and any repositories that you want to provide as context for the agent. You can modify this selection anytime in your [GitHub App settings](https://github.com/apps/mintlify/installations/new). +When installing the GitHub App, you can grant access to all of your repositories or specific ones. We recommend granting access to: +- Your documentation repository for automatic deployments +- Any repositories where you want to mention `@mintlify` in pull request comments to create documentation updates +- Any repositories that you want to provide as context for the agent + +You can modify this selection anytime in your [GitHub App settings](https://github.com/apps/mintlify/installations/new). ## Configure docs source