Skip to content

Document agent feedback for markdown exports #5212

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
+20 −0
Open

Document agent feedback for markdown exports #5212

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
19 changes: 19 additions & 0 deletions ai/markdown-export.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,22 @@
## Keyboard shortcut

Press <kbd>Command</kbd> + <kbd>C</kbd> (<kbd>Ctrl</kbd> + <kbd>C</kbd> on Windows) to copy a page as Markdown to your clipboard.

## Agent feedback

When agent feedback is enabled, Markdown exports include an embedded feedback instruction block that lets AI agents programmatically report documentation issues. Agents can submit feedback by sending a POST request to the endpoint URL included in the Markdown output.

Check warning on line 33 in ai/markdown-export.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/markdown-export.mdx#L33 

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

The feedback instruction block appears at the top of every Markdown export and contains the endpoint URL and expected request format:

```bash
curl -X POST https://your-domain.com/_mintlify/feedback/{subdomain}/agent-feedback \
-H "Content-Type: application/json" \
-d '{"path": "/current-page-path", "feedback": "Description of the issue"}'
```

| Field | Type | Required | Description |
| ---------- | ------ | -------- | ---------------------------------------- |
| `path` | string | Yes | The page path the feedback is about. |
| `feedback` | string | Yes | A description of the documentation issue. |

Agent feedback appears alongside other feedback in your [feedback dashboard](https://dashboard.mintlify.com/products/analytics/v2/feedback). See [Feedback](/optimize/feedback) for more information on managing feedback.
1 change: 1 addition & 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,7 @@
- **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**: Feedback submitted by AI agents when consuming [Markdown exports](/ai/markdown-export#agent-feedback). When enabled, Markdown exports include an endpoint that agents can use to report documentation issues.

## Collect email addresses

Expand Down Expand Up @@ -80,7 +81,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 84 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L84 

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

### Filter by status
Expand Down
Loading