Add docs for @mintlify GitHub PR comment bot#5209
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for the new
@mintlifyGitHub PR comment bot feature introduced in mintlify/server#4470.Changes
agent/github.mdx— Documents how to use@mintlifyin GitHub PR comments, covering same-repo and cross-repo scenarios, supported comment types, and session reuse for follow-ups.agent/index.mdx— Added GitHub PR comments as a trigger source and a "Use on GitHub" card in next steps.agent/use-cases.mdx— Added a "Document a pull request from GitHub" use case.docs.json— Addedagent/githubto the Agent navigation group.Note
Low Risk
Low risk: documentation-only changes (new MDX page plus navigation copy updates) with no product logic or data/security impact.
Overview
Adds a new
agent/github.mdxpage documenting how to trigger the Mintlify agent from GitHub PR comments via@mintlify, including same-repo vs cross-repo behavior, supported comment types, follow-ups, and best practices.Updates the agent landing docs (
agent/index.mdx) and use cases (agent/use-cases.mdx) to include GitHub PR comments as a first-class trigger, and wires the new page into the Agent navigation indocs.json.Reviewed by Cursor Bugbot for commit 84b6096. Bugbot is set up for automated code reviews on this repo. Configure here.