Skip to content
Open
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
26 changes: 25 additions & 1 deletion ai/agent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

## Use the agent in the dashboard

Access the agent in a from your dashboard using the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux), or by clicking the **Ask agent** button. The agent panel is resizable on desktop. On mobile devices, the agent opens in full-screen.

Check warning on line 22 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L22

Did you really mean 'resizable'?

The agent panel has three views.

Expand All @@ -36,7 +36,7 @@
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 39 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L39

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

1. Open the agent panel in your dashboard.
Expand All @@ -52,6 +52,28 @@
- 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.

<Note>
The GitHub App must be installed and configured for the agent to respond to PR comments. See [GitHub integration](/deploy/github) for setup instructions.

Check warning on line 60 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L60

In general, use active voice instead of passive voice ('be installed').
</Note>

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.
Expand Down Expand Up @@ -98,7 +120,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 123 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L123

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

## Write effective prompts

Expand All @@ -118,7 +140,9 @@

## 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`.

Expand Down
9 changes: 7 additions & 2 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
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.

<Tip>
**Do you need the GitHub App?**
Expand All @@ -17,7 +17,7 @@

If your repository is in the `mintlify-community` organization, the GitHub App is automatically configured and managed by Mintlify. You can use the web editor to make changes to your documentation. If you want to work on your documentation locally, clone the repository to your own organization and update your Git settings to use your own repository.

## Install the GitHub App

Check warning on line 20 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L20

'Install 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 @@ -26,7 +26,7 @@
Install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).

<Tip>
We recommend only granting access to your documentation repository.

Check warning on line 29 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L29

Try to avoid using first-person plural like 'We'.
</Tip>

<Frame>
Expand All @@ -52,15 +52,20 @@

## 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:

Check warning on line 55 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L55

Try to avoid using first-person plural like 'We'.
- 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

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

## GitHub Enterprise with IP allowlists

Check warning on line 66 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L66

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 68 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L68

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 @@ -84,7 +89,7 @@
</Accordion>
</AccordionGroup>

### GitHub App connection issues

Check warning on line 92 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L92

'GitHub App connection issues' should use sentence-style capitalization.

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

Expand All @@ -101,7 +106,7 @@

### 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 109 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L109

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

<Steps>
<Step title="Navigate to Git Settings">
Expand Down