Skip to content

Document agent feedback feature #5405

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

Open
mintlify wants to merge 1 commit into
base: main
Choose a base branch
from
+33 −0
Open

Document agent feedback feature #5405

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
33 changes: 33 additions & 0 deletions optimize/feedback.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,39 @@
- **Raise issues**: Allow users to create GitHub issues directly from your documentation. Only available for public GitHub repositories.
- **Contextual feedback**: Free form feedback about the content of a page.
- **Code snippet feedback**: Feedback specifically on code snippets.
- **Agent feedback** <Tooltip tip="This feature is in beta.">Beta</Tooltip>: Structured feedback submitted by AI agents about content quality, accuracy, and completeness.

## Agent feedback

<Note>
Agent feedback is in beta. Enable it from the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard.
</Note>

When agent feedback is enabled, AI agents that read your documentation through the [markdown export](/ai/markdown-export) receive instructions to submit feedback when they encounter issues with your content. This gives you a signal from AI systems about documentation quality that you wouldn't otherwise receive.

Check warning on line 64 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L64 

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

### How it works

1. Enable agent feedback from the [Add-ons](https://dashboard.mintlify.com/products/addons) page.
2. When an AI agent fetches a page in markdown format, the response includes instructions for submitting feedback.

Check warning on line 69 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L69 

Use 'Markdown' instead of 'markdown'.
3. If the agent finds an issue with the content, it sends a POST request to your site's `/feedback` endpoint with the page path and a description of the issue.
4. The feedback appears in your [feedback dashboard](https://dashboard.mintlify.com/products/analytics/v2/feedback) with an **Agent** badge.

### Feedback format

Agents submit feedback as a JSON POST request to `https://your-docs-domain.com/feedback`:

```json
{
"path": "/page-path",
"feedback": "Description of the issue"
}
```

### Viewing agent feedback

Agent feedback appears alongside other feedback types in your dashboard. Each piece of agent feedback is labeled with an **Agent** badge so you can distinguish it from human feedback.

Check warning on line 86 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L86 

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

Use the **Show agent feedback** toggle in the feedback dashboard to filter agent feedback in or out.

## Collect email addresses

Expand Down Expand Up @@ -80,7 +113,7 @@

- **Pending**: Feedback is awaiting review.
- **In Progress**: Work is in progress to address the feedback.
- **Resolved**: Feedback has been resolved.

Check warning on line 116 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L116 

In general, use active voice instead of passive voice ('been resolved').
- **Dismissed**: Feedback is irrelevant or inaccurate.

### Filter by status
Expand Down
Loading