Skip to content
Merged
Show file tree
Hide file tree
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: 57 additions & 0 deletions analytics/feedback.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "Feedback"
description: "Monitor user satisfaction with your documentation"
---

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

The 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.

Access the feedback tab by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics).

## Feedback types

The feedback tab displays information according to the feedback add-ons that you enable.

Enable your preferred feedback types:

* **Thumbs rating only**: Simple thumbs up/down voting to gauge overall satisfaction with pages.
* **Code snippet feedback only**: Feedback specifically on code snippets.
* **Thumbs rating and contextual feedback**: Page voting plus detailed comments and reasons for ratings.
* **Thumbs rating and code snippet feedback**: Page voting plus feedback on code examples.
* **Thumbs rating, contextual, and code snippet feedback**: Complete feedback system with page voting, detailed comments, and code snippet feedback.

## Managing feedback

For contextual and code snippet feedback, you can set the status of a piece of feedback and add internal notes to track your work resolving user feedback.

### Changing feedback status

Select the status beside a piece of feedback to mark it as **Pending**, **In Progress**, **Resolved**, or **Dismissed**.

Best practices for setting feedback statuses:

* **Pending**: Feedback is awaiting review.
* **In Progress**: Feedback has been validated and is being worked on.
* **Resolved**: Feedback has been resolved.
* **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate.

### Filtering by status

Use the status filter to control which feedback is displayed. Uncheck a status to hide all feedback with that status. By default, all feedback is displayed.

Check warning on line 43 in analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/feedback.mdx#L43

Did you really mean 'Uncheck'?

### Adding internal notes

Click on 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.

## Using feedback data

Review your feedback data to:

* **Identify successful content**: Pages with the most positive feedback show what works well in your documentation.
* **Prioritize improvements**: Pages with the most negative feedback indicate what content might need attention.
* **Take action**: Make documentation updates based on direct user feedback.
30 changes: 30 additions & 0 deletions analytics/improving-docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Improving your docs"
description: "Use analytics data to make your documentation better"
---

Improve your docs based on quantitative and qualitative data from your analytics dashboard.

## Cross-analytics insights

Combine information from multiple analytics sources to get a holistic view of your documentation.

### Correlate traffic and satisfaction
- **High traffic and low feedback scores**: Popular pages with a poor user experience. Prioritize improving these pages.
- **Low traffic and high feedback scores**: Documentation that is working well, but might not be discoverable. Consider promoting these pages.
- **High traffic and high feedback scores**: Your documentation's greatest hits. Review these pages for ideas to improve the rest of your content.

### Match search intent with content performance
- **High search volume and low page views**: Discoverability problems. Consider moving these pages or reviewing their frontmatter.

Check warning on line 18 in analytics/improving-docs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/improving-docs.mdx#L18

Did you really mean 'Discoverability'?

Check warning on line 18 in analytics/improving-docs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/improving-docs.mdx#L18

Did you really mean 'frontmatter'?
- **Popular search terms and low-confidence results**: Content gap opportunity. Consider adding more content or new content on these topics.
- **Top searches and negative feedback on matching pages**: User experience issues. Review the pages to see if they solve the user need that is being searched for.

## Put insights into action

Use these cross-analytics patterns to prioritize your documentation improvements:

- **Fix high-impact problems first**: Popular pages with poor feedback scores affect the most users.
- **Fill verified content gaps**: Low-confidence searches with high volume indicate unmet user needs.
- **Respond to user feedback**: Contextual and code snippet feedback can identify specific areas for improvement.
- **Align search and content**: Ensure your most-searched topics have comprehensive, well-organized pages.
- **Monitor rising search trends with no existing popular pages**: New content opportunities.
25 changes: 25 additions & 0 deletions analytics/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: "Overview"
description: "View traffic and high-level insights about your documentation"
---

The overview tab shows how many people have visited your docs, what pages are most popular, and where users are coming from. Use this information to identify which pages are most valuable to your users and track trends over time.

Access the overview metrics by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics).

## Metrics

Use the range selector to adjust the time period for displayed data. Select visitors, views, or actions to display a line graph showing trends over the selected time period.

- **Visitors**: Unique visitors
- **Views**: Total page views
- **Actions**: Combined count of API calls, navbar link clicks, and CTA button clicks

Check warning on line 16 in analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/overview.mdx#L16

Did you really mean 'navbar'?
- **Popular Pages**: Paths to the most-visited pages and their view counts
- **Referrers**: Top traffic sources directing users to your docs

## Using overview data

Review your overview analytics to:

- **Identify popular pages**: Use popular pages to understand what content is most important to your users so that you can make sure it is up to date and comprehensive.
- **Track traffic trends**: Monitor changes in traffic to understand the impact of updates or new content.
24 changes: 24 additions & 0 deletions analytics/search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Search"
description: "Understand how users search within your documentation"
---

Use the data on the search tab to understand what users are searching for and identify topics that need to be updated or expanded.

Access your search metrics by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics).

## Search metrics

Use the range selector to adjust the time period for displayed data.

- **Total queries**: Search volume
- **Top searches**: Most-searched terms
- **Low-confidence searches**: Queries that may not have returned relevant results

## Using search data

Review your search analytics to:

- **Identify popular topics**: Use top searches to understand what content people want to find.
- **Find content gaps**: Low-confidence searches may indicate missing documentation or topics that need better coverage.
- **Improve discoverability**: Ensure that pages matching popular search terms are easy to find and well-organized.

Check warning on line 24 in analytics/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

analytics/search.mdx#L24

Did you really mean 'discoverability'?
15 changes: 14 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,16 @@
"group": "Guides",
"pages": [
"guides/migration",
"guides/analytics",
{
"group": "Analytics dashboard",
"icon": "chart-line",
"pages": [
"analytics/overview",
"analytics/feedback",
"analytics/search",
"analytics/improving-docs"
]
},
"react-components",
"settings/custom-scripts",
"settings/seo",
Expand Down Expand Up @@ -531,6 +540,10 @@
{
"source": "editor",
"destination": "editor/getting-started"
},
{
"source": "guides/analytics",
"destination": "analytics/overview"
}
],
"integrations": {
Expand Down
51 changes: 0 additions & 51 deletions guides/analytics.mdx

This file was deleted.