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
29 changes: 16 additions & 13 deletions 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 Down Expand Up @@ -98,7 +98,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 101 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L101

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

## Write effective prompts

Expand All @@ -116,19 +116,6 @@
- `@mintlify Find and fix all typos in the docs`
- `@mintlify change all unordered lists to use * instead of -`

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

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

Use the format `@mintlify subdomain=<your-domain-name> <your-prompt>` to prompt the agent to work on a specific documentation set.

Examples:

- `@mintlify subdomain=public-docs Add a new section to the quickstart about inviting collaborators based on this PR`: Prompts the agent to update the quickstart only on the `public-docs` site.
- `@mintlify subdomain=customer-docs Update the auth docs for the new authentication method`: Prompts the agent to update the auth docs only on the `customer-docs` site.

## Agent workflows

The agent assists with many different documentation tasks. These workflows show some of the ways you can integrate the agent into your documentation process. Try an approach that fits how your team currently works and adapt it to your specific needs.
Expand All @@ -151,6 +138,22 @@

For example: `@mintlify This PR adds a new authentication method. Update the docs to include the new auth flow: [PR link]`.

### Mention @mintlify on any pull request

You can mention `@mintlify` directly in comments on any pull request in your organization, not just your documentation repository. When you tag the agent on a non-docs PR, it automatically creates a separate pull request in your documentation repository with the requested changes.

This workflow is useful when you want to update documentation as part of your feature development process without leaving your code review context.

For example, comment on a feature PR: `@mintlify Document this new API endpoint and add it to the API reference`.

The agent will:

Check warning on line 149 in ai/agent.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/agent.mdx#L149

Avoid using 'will'.
1. Analyze the PR context and your request
2. Create a new branch in your documentation repository
3. Make the requested documentation changes
4. Open a pull request and comment back on the original PR with a link

If you make additional requests on the same PR, the agent adds commits to the existing documentation PR rather than creating new ones.

### Generate release notes from a pull request

Prompt the agent with a specific pull request to generate release notes or changelog updates based on the commit history.
Expand Down
17 changes: 17 additions & 0 deletions 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,32 @@

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

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

## Use @mintlify on pull requests

Mention `@mintlify` in pull request comments to trigger documentation updates directly from your code review workflow. The agent works on both your documentation repository and any other repository in your organization that has the GitHub App installed.

When you mention `@mintlify` on a pull request in your documentation repository, the agent commits changes directly to the PR branch.

When you mention `@mintlify` on a pull request in a non-docs repository, the agent:
1. Creates a new branch in your documentation repository
2. Makes the requested documentation changes
3. Opens a pull request and comments back on the original PR with a link

This allows you to update documentation as part of your feature development process without leaving your code review context. For example, comment on a feature PR: `@mintlify Document this new API endpoint`.

<Tip>
Grant the GitHub App access to repositories where you want to use `@mintlify` in PR comments. The agent can only respond to mentions in repositories it has access to.
</Tip>

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L78

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L80

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

### GitHub App connection issues

Check warning on line 104 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L104

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L121

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

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