Skip to content
Closed
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
57 changes: 50 additions & 7 deletions optimize/feedback.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "Feedback"
description: "Monitor user satisfaction and feedback on your documentation."
keywords: ["user feedback","thumbs rating","contextual feedback","satisfaction"]
keywords: ["user feedback","thumbs rating","contextual feedback","satisfaction","abuse flagging"]
---

<Info>
To collect and view feedback, you must enable feedback from the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard.
To collect and view feedback, you must enable feedback from the [Add-ons](https://dashboard.mintlify.com/settings/deployment/addons) page in your dashboard settings.
</Info>

The [feedback](https://dashboard.mintlify.com/products/analytics/v2/feedback) tab displays quantitative thumbs up and thumbs down votes your docs have received and any qualitative feedback that users have provided. Use this information to gauge the quality of your docs and make improvements.
Expand All @@ -29,10 +29,10 @@ View feedback on the analytics page in your dashboard.
## Feedback types

<Note>
Contextual and code snippet feedback are in beta. To enable them for your documentation site, [contact our sales team](mailto:hahnbee@mintlify.com).
Contextual and code snippet feedback are in beta. To enable them for your documentation site, [contact our sales team](mailto:gtm@mintlify.com).
</Note>

The feedback tab displays information according to the [feedback add-ons](https://dashboard.mintlify.com/products/addons) that you enable.
The feedback tab displays information according to the [feedback add-ons](https://dashboard.mintlify.com/settings/deployment/addons) that you enable.

<Frame>
<img
Expand All @@ -54,9 +54,28 @@ The feedback tab displays information according to the [feedback add-ons](https:
- **Edit suggestions**: Allow users to suggest edits to your documentation. Only available for public GitHub repositories.
- **Raise issues**: Allow users to create GitHub issues directly from your documentation. Only available for public GitHub repositories.

The feedback dashboard organizes this data into two main views:

- **Detailed feedback**: Shows contextual page-level feedback and thumbs-only ratings. You can filter between all feedback, page feedback only, or thumbs-only ratings.
- **Code snippets**: Shows feedback specifically about code snippets in your documentation.

## Feedback overview chart

The feedback tab includes a bar chart that summarizes feedback over time. The chart displays three categories with color-coded totals:

- **Thumbs Up**: Positive ratings from readers.
- **Thumbs Down**: Negative ratings from readers.
- **Code**: Feedback on code snippets.

Below the chart, the **Liked by viewers** and **Needs improvement** sections show which pages received the most positive and negative ratings, helping you quickly identify content that works well and content that needs attention.

## Collect email addresses

Users can optionally provide their email address when submitting feedback. The email field appears when a user selects **Other** as their feedback category, allowing them to share contact information for follow-up.
You can enable an optional email field on the feedback form so readers can share their contact information when submitting feedback. To configure this setting:

1. Go to [Settings > Add-ons](https://dashboard.mintlify.com/settings/deployment/addons) in your dashboard.
2. Under **Contextual feedback**, enable **Collect reader emails**.
3. Optionally add a privacy disclaimer that appears alongside the email field.

You can view email addresses submitted with feedback in the [feedback dashboard](https://dashboard.mintlify.com/products/analytics/v2/feedback) alongside the feedback content.

Expand All @@ -79,16 +98,40 @@ Best practices for setting feedback statuses:
- **Resolved**: Feedback has been resolved.
- **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate.

### Filter by status
### Filter feedback

Use the **Status** filter to control which feedback is displayed by status. Clear a status to hide all feedback with that status. By default, all statuses are shown.

Use the **Show abusive** toggle to include or exclude feedback that has been flagged as abusive.

Use the status filter to control which feedback is displayed. Clear a status to hide all feedback with that status. By default, all feedback is displayed.
You can also search feedback by keyword to find specific items.

### Add internal notes

Click a piece of feedback to add an internal note. These notes are only visible to people with access to your dashboard.

Use notes to add information for collaboration, link relevant support or engineering tickets, or remember any other useful information.

### Flag abusive feedback

You can flag feedback as abusive to separate low-quality or inappropriate submissions from genuine user input. Flagged feedback is hidden by default and does not appear in the feedback overview chart unless you enable the **Show abusive** toggle.

To flag a single item, click on the feedback to open its detail view, then select **Flag as abuse**. To unflag it, select **Unflag as abuse** from the same view.

The detail view for flagged feedback shows the abuse classification, including:

- **Detection method**: Whether the feedback was flagged manually or automatically.
- **Reason**: The reason the feedback was flagged, if available.
- **Confidence**: The confidence score for automatic detections.

### Bulk actions

Enable **Select** mode on the feedback table to perform actions on multiple items at once. You can:

- Change the status of selected items.
- Flag or unflag selected items as abusive.
- Delete selected items.

## Use feedback data

Review your feedback data to:
Expand Down
Loading