Skip to content

Add feedback by page view documentation #4205

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
Open

Add feedback by page view documentation #4205

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
11 changes: 11 additions & 0 deletions optimize/feedback.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,13 @@
Best practices for setting feedback statuses:

- **Pending**: Feedback is awaiting review.
- **In Progress**: Feedback has been validated and is being worked on.

Check warning on line 78 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L78 

In general, use active voice instead of passive voice ('been validated').

Check warning on line 78 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L78 

In general, use active voice instead of passive voice ('being worked').
- **Resolved**: Feedback has been resolved.

Check warning on line 79 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L79 

In general, use active voice instead of passive voice ('been resolved').
- **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate.

Check warning on line 80 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L80 

In general, use active voice instead of passive voice ('been dismissed').

### Filter by status

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.

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 ('is displayed').

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 ('is displayed').

### Add internal notes

Expand All @@ -89,6 +89,17 @@

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

## View feedback by page

Toggle between **All feedback** and **Feedback by page** views using the button group at the top of the feedback tab.

The **Feedback by page** view aggregates thumbs up and thumbs down votes by page, helping you quickly identify which pages resonate with readers and which need improvement.

- **Liked by viewers**: Pages with more positive than negative feedback, sorted by net positive votes.
- **Needs improvement**: Pages with more negative than positive feedback, sorted by net negative votes.

Use this view to prioritize documentation updates based on overall page sentiment rather than individual feedback items.

## Use feedback data

Review your feedback data to:
Expand Down