Skip to content

Update agent docs with new capabilities #3428

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

Closed
ethanpalm wants to merge 1 commit into from
Closed

Update agent docs with new capabilities #3428

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion agent/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,15 @@

- Write new content based on your prompts, links to pull requests, or Slack threads.
- Revise outdated code examples and API references.
- Search and update existing content.
- Search and update existing content across multiple files.
- Read and process files, images, and attachments from Slack messages or the dashboard.
- Address PR review comments and code review feedback.
- Answer questions about your docs and technical writing topics.
- Capture knowledge from Slack conversations and pull requests before it gets lost.

## Where you can use the agent

- **Dashboard**: From any page in your dashboard, use the keyboard shortcut <kbd>⌘</kbd>+<kbd>I</kbd> (macOS) or <kbd>Ctrl</kbd>+<kbd>I</kbd> (Windows/Linux) to open the agent panel. Or click **Ask agent** on the [Overview](https://dashboard.mintlify.com/) page.

Check warning on line 27 in agent/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/index.mdx#L27 

Avoid first-person pronouns such as ' I '.
<Frame>
<img src="/images/agent/dashboard-light.png" alt="The agent panel open in the dashboard." className="block dark:hidden" />
<img src="/images/agent/dashboard-dark.png" alt="The agent panel open in the dashboard." className="hidden dark:block" />
Expand Down
1 change: 1 addition & 0 deletions agent/slack.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Once connected, you can:
- Mention `@mintlify` in a channel to use it publicly and collaboratively.
- Continue conversations in threads to iterate on changes.
- Share pull request links with the agent to update related documentation.
- Attach files and images to your messages for the agent to process and include in documentation.

## Update documentation

Expand Down
12 changes: 12 additions & 0 deletions agent/workflows.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,24 @@ Prompt the agent with a specific pull request to generate release notes or chang

For example: `@mintlify Generate release notes for this PR: [PR link]`.

## Address pull request review feedback

Share a pull request link with the agent to address reviewer comments and code review feedback on documentation pull requests.

For example: `@mintlify Address the review comments on this PR: [PR link]`.

## Generate code examples

Prompt the agent to generate code examples for features throughout your docs or on specific pages.

For example: `@mintlify Generate a code example to make the authentication method easier to understand`.

## Add images or files to your docs

Attach files or images directly to your Slack message when prompting the agent. The agent processes the attachment and includes it in the documentation.

For example: `@mintlify Add this diagram to the architecture overview page` with the image attached to the message.

## Review existing content

Prompt the agent to review existing content for technical accuracy, style, grammar, or other issues.
Expand Down