Skip to content

Pull Request Summary #2095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mintlify-development wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Pull Request Summary #2095

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 17 additions & 0 deletions ai/agent.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
You can also use the agent in Slack to collaborate with your team on documentation updates.

<Note>
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify app before you connect it.

Check warning on line 42 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L42 

Use 'administrator' instead of 'admin'.
</Note>

1. Open the agent panel in your dashboard.
Expand All @@ -55,6 +55,23 @@
- Send a direct message to it.
- Mention it with `@mintlify` in a channel.

## Use the agent in GitHub pull requests

You can mention `@mintlify` in comments on pull requests in your documentation repository to trigger the agent directly from GitHub.

When you mention `@mintlify` in a PR comment, the agent:

1. Adds an eyes reaction (👀) to your comment to indicate it's processing your request

Check warning on line 64 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L64 

Use parentheses judiciously.
2. Analyzes your prompt and the PR context
3. Creates commits with the requested changes directly to the PR branch
4. Replaces the eyes reaction with a thumbs up (👍) when complete

Check warning on line 67 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L67 

Use parentheses judiciously.

This works for both:
- **Issue comments**: General comments on the pull request
- **Review comments**: Comments on specific lines of code in the Files Changed view

The agent only responds to `@mintlify` mentions on pull requests in repositories connected to your documentation deployment.

## Connect repositories as context

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).
Expand All @@ -63,7 +80,7 @@

Use the agent endpoints to [create jobs](/api-reference/agent/create-agent-job), [get a specific job](/api-reference/agent/get-agent-job), and [get all jobs](/api-reference/agent/get-all-jobs).

When creating jobs via the API, you can control whether pull requests are created in draft mode using the `asDraft` parameter (defaults to `true`). Set `asDraft: false` to create non-draft pull requests ready for immediate review and merging in automated workflows.

Check warning on line 83 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L83 

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

## Write effective prompts

Expand Down