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
25 changes: 24 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,27 @@
- Send a direct message to it.
- Mention it with `@mintlify` in a channel.

## Use the agent on GitHub pull requests

Mention `@mintlify` in comments on any GitHub pull request to create documentation updates in your docs repository. The agent analyzes the PR context and creates a documentation PR with relevant changes.

<Note>
The GitHub App must be installed and configured to use the agent on pull requests. 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>

To use the agent on GitHub:

1. Open any pull request in a repository where you have the Mintlify GitHub App installed.
1. Add a comment mentioning `@mintlify` with your documentation request.
1. The agent creates a pull request in your documentation repository with the requested changes.

The agent works on pull requests in any repository, not just your documentation repository. This lets you update docs directly from feature PRs, bug fixes, or any code changes.

For example:
- `@mintlify Update the API docs to reflect the new authentication flow in this PR`
- `@mintlify Add a guide showing how to use this new feature`
- `@mintlify Update the changelog with these changes`

## 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 +119,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 122 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L122

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

## Write effective prompts

Expand All @@ -118,7 +139,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 automatically selects the correct deployment based on your prompt context. In most cases, you don't need to manually specify which documentation set to update.

If you need to explicitly specify a deployment, 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
6 changes: 5 additions & 1 deletion deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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,19 @@

## 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 only granting access to your documentation repository and any repositories that you want to provide as context for the agent.

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'.

Grant the agent access to additional repositories to enable `@mintlify` mentions in pull requests across your organization. When you mention `@mintlify` in a PR comment on any repository with the GitHub App installed, the agent creates documentation updates in your docs repository.

You can modify repository access 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 65 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L65

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L67

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

### GitHub App connection issues

Check warning on line 91 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L91

'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 +105,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 108 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L108

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

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