Skip to content
Closed
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
22 changes: 22 additions & 0 deletions ai/agent.mdx
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,28 @@
- Send a direct message to it.
- Mention it with `@mintlify` in a channel.

## Use the agent on GitHub pull requests

The agent can respond to comments on pull requests in your documentation repository. When you mention `@mintlify` in a pull request comment or review comment, the agent processes your request and pushes updates directly to the pull request branch.

<Note>
The agent only responds to `@mintlify` mentions on pull requests in repositories connected to your Mintlify project through the GitHub App.
</Note>

To use the agent on a pull request:

1. Open a pull request in your documentation repository.
2. Add a comment or review comment that includes `@mintlify` followed by your request.
3. The agent processes your request and pushes changes to the pull request branch.

Examples:

- `@mintlify Fix the typo in the authentication section`
- `@mintlify Add a code example for the new API endpoint`
- `@mintlify Update this section to clarify the installation steps`

The agent reacts with 👀 while processing your request and ✅ when complete.

## 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 Down
2 changes: 2 additions & 0 deletions api/agent/create-agent-job.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@

This endpoint creates an agent job based on provided messages and branch information. The job executes asynchronously and returns a streaming response with the execution details and results.

If a branch doesn't exist, the agent creates one. If files are edited successfully, a draft pull request is automatically created at the end of the job.

Check warning on line 8 in api/agent/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/create-agent-job.mdx#L8

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

The agent can be triggered from multiple sources including the dashboard, Slack, GitHub pull request comments, or direct API calls. When triggered from GitHub pull requests via `@mintlify` mentions, the `source` field is automatically set to `github`.

Check warning on line 10 in api/agent/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/create-agent-job.mdx#L10

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

## Rate limits

The agent API has the following limits:
Expand Down
2 changes: 2 additions & 0 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository.

## Installing the GitHub App

Check warning on line 9 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L9

'Installing the GitHub App' should use sentence-style capitalization.

<Note>
You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
Expand All @@ -15,7 +15,7 @@
Install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).

<Tip>
We recommend granting access only to the repository where your docs are hosted.

Check warning on line 18 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L18

Try to avoid using first-person plural like 'We'.

Check warning on line 18 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L18

In general, use active voice instead of passive voice ('are hosted').
</Tip>

<Frame>
Expand All @@ -24,7 +24,7 @@

## Permissions

When you install the GitHub app, you will be prompted to grant the following permissions:

Check warning on line 27 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L27

Avoid using 'will'.

Check warning on line 27 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L27

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

Read permissions:
* `metadata`: Basic repository information
Expand All @@ -34,6 +34,8 @@
* `code`: Read file changes when you commit to your docs branch
* `deployments`: Generate preview deployments for pull requests
* `pull requests`: Create branches and pull requests from the web editor
* `issue comments`: Respond to `@mintlify` mentions in pull request comments
* `pull request review comments`: Respond to `@mintlify` mentions in pull request review comments

<Info>
The app only accesses repositories that you explicitly grant it access to. If you have branch protection rules enabled, the app can't push directly to protected branches.
Expand All @@ -41,15 +43,15 @@

## Managing repository access

When installing our GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to the repositories where your documentation is located. You can modify this selection anytime in your [GitHub app settings](https://github.com/apps/mintlify/installations/new).

Check warning on line 46 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L46

Try to avoid using first-person plural like 'our'.

Check warning on line 46 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L46

Try to avoid using first-person plural like 'We'.

Check warning on line 46 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L46

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

## Configuring docs source

Change the organization, repository, or branch that your documentation is built from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard.

Check warning on line 50 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L50

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

## GitHub Enterprise with IP allowlists

Check warning on line 52 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L52

Did you really mean 'allowlists'?

If your GitHub Enterprise Cloud organization has an IP allowlist enabled, you need to add Mintlify's egress IP address (`54.242.90.151`) to your allowlist for the GitHub App to function properly.

Check warning on line 54 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L54

Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.

Follow [GitHub's documentation](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization) to configure your IP allowlist.

Expand All @@ -72,14 +74,14 @@

### Feedback add-ons are unavailable

If you cannot enable the edit suggestions or raise issues options in your dashboard and your repository is public, revalidate your Git settings.

Check warning on line 77 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L77

Use 'can't' instead of 'cannot'.

<Steps>
<Step title="Navigate to Git Settings">
Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
</Step>
<Step title="Revalidate your settings">
Click the green check mark in the corner of the Git settings box to revalidate your repository settings. This will force update your repository settings to reflect whether your repository is public or private.

Check warning on line 84 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L84

Avoid using 'will'.

<Frame>
<img
Expand Down