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
2 changes: 1 addition & 1 deletion deploy/csp-configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
---
title: "Content Security Policy (CSP) configuration"

Check warning on line 2 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L2

Use parentheses judiciously.
sidebarTitle: "CSP configuration"
description: "Domain whitelist and header configurations for reverse proxies, firewalls, and networks that enforce strict security policies"

Check warning on line 4 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L4

Use 'firewall rules' instead of 'firewalls'.
---

Content Security Policy (CSP) is a security standard that helps prevent cross-site scripting (XSS) attacks by controlling which resources a web page can load. Mintlify serves a default CSP that protects most sites. If you host your documentation behind a reverse proxy or firewall, that overwrites the default CSP, you may need to configure CSP headers for features to function properly.

Check warning on line 7 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L7

Use parentheses judiciously.

## CSP directives

Check warning on line 9 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L9

'CSP directives' should use sentence-style capitalization.

The following CSP directives are used to control which resources can be loaded:

Check warning on line 11 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L11

In general, use active voice instead of passive voice ('are used').

Check warning on line 11 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L11

In general, use active voice instead of passive voice ('be loaded').

- `script-src`: Controls which scripts can be executed

Check warning on line 13 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L13

In general, use active voice instead of passive voice ('be executed').
- `style-src`: Controls which stylesheets can be loaded

Check warning on line 14 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L14

In general, use active voice instead of passive voice ('be loaded').
- `font-src`: Controls which fonts can be loaded

Check warning on line 15 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L15

In general, use active voice instead of passive voice ('be loaded').
- `img-src`: Controls which images, icons, and logos can be loaded

Check warning on line 16 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L16

In general, use active voice instead of passive voice ('be loaded').
- `connect-src`: Controls which URLs can be connected to for API calls and WebSocket connections

Check warning on line 17 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L17

In general, use active voice instead of passive voice ('be connected').
- `frame-src`: Controls which URLs can be embedded in frames or iframes

Check warning on line 18 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L18

In general, use active voice instead of passive voice ('be embedded').
- `default-src`: Fallback for other directives when not explicitly set

## Domain whitelist
Expand All @@ -24,7 +24,7 @@
|:-------|:--------|:--------------|:-------|
| `d4tuoctqmanu0.cloudfront.net` | KaTeX CSS, fonts | `style-src`, `font-src` | Required |
| `*.mintlify.dev` | Documentation content | `connect-src`, `frame-src` | Required |
| `*.mintlify.com` | Dashboard, API, analytics proxy | `connect-src` | Required |
| `*.mintlify.com` | Dashboard, API, insights proxy | `connect-src` | Required |
| `leaves.mintlify.com` | Assistant API | `connect-src` | Required |
| `d3gk2c5xim1je2.cloudfront.net` | Icons, images, logos | `img-src` | Required |
| `d1ctpt7j8wusba.cloudfront.net` | Mint version and release files | `connect-src` | Required |
Expand All @@ -33,7 +33,7 @@
| `api.mintlifytrieve.com` | Search API | `connect-src` | Required |
| `cdn.jsdelivr.net` | Emoji assets for OG images | `script-src`, `img-src` | Required |
| `fonts.googleapis.com` | Google Fonts | `style-src`, `font-src` | Optional |
| `www.googletagmanager.com` | Google Analytics/GTM | `script-src`, `connect-src` | Optional |

Check warning on line 36 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L36

Spell out 'GTM', if it's unfamiliar to the audience.
| `cdn.segment.com` | Segment analytics | `script-src`, `connect-src` | Optional |
| `plausible.io` | Plausible analytics | `script-src`, `connect-src` | Optional |
| `us.posthog.com` | PostHog analytics | `connect-src` | Optional |
Expand All @@ -44,10 +44,10 @@
| `browser.sentry-cdn.com` | Sentry error tracking | `script-src`, `connect-src` | Optional |
| `js.sentry-cdn.com` | Sentry JavaScript SDK | `script-src` | Optional |

## Example CSP configuration

Check warning on line 47 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L47

'Example CSP configuration' should use sentence-style capitalization.

<Note>
Only include domains for services that you use. Remove any analytics domains that you have not configured for your documentation.

Check warning on line 50 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L50

Use 'haven't' instead of 'have not'.
</Note>

```text wrap
Expand Down
24 changes: 12 additions & 12 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -163,11 +163,11 @@
]
},
{
"group": "Analytics",
"group": "Insights",
"pages": [
"analytics/overview",
"analytics/feedback",
"analytics/search"
"insights/overview",
"insights/feedback",
"insights/search"
]
},
"optimize/seo",
Expand Down Expand Up @@ -244,7 +244,7 @@
]
},
{
"group": "Analytics",
"group": "Insights",
"icon": "chart-line",
"pages": [
"guides/improving-docs"
Expand Down Expand Up @@ -462,7 +462,7 @@
]
},
{
"group": "Analytics",
"group": "Insights",
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Navigation Group Renaming Causes Path Mismatch

The "Analytics" navigation group was renamed to "Insights" in docs.json for French, Spanish, and Chinese. However, the page paths within these groups (e.g., fr/analytics/overview) were not updated to insights/ paths, causing broken navigation links.

Additional Locations (3)

Fix in Cursor Fix in Web

"pages": [
"fr/analytics/overview",
"fr/analytics/feedback",
Expand Down Expand Up @@ -543,7 +543,7 @@
]
},
{
"group": "Analytics",
"group": "Insights",
"icon": "chart-line",
"pages": [
"fr/guides/improving-docs"
Expand Down Expand Up @@ -761,7 +761,7 @@
]
},
{
"group": "Analytics",
"group": "Insights",
"pages": [
"es/analytics/overview",
"es/analytics/feedback",
Expand Down Expand Up @@ -842,7 +842,7 @@
]
},
{
"group": "Analytics",
"group": "Insights",
"icon": "chart-line",
"pages": [
"es/guides/improving-docs"
Expand Down Expand Up @@ -1060,7 +1060,7 @@
]
},
{
"group": "Analytics",
"group": "Insights",
"pages": [
"zh/analytics/overview",
"zh/analytics/feedback",
Expand Down Expand Up @@ -1141,7 +1141,7 @@
]
},
{
"group": "Analytics",
"group": "Insights",
"icon": "chart-line",
"pages": [
"zh/guides/improving-docs"
Expand Down Expand Up @@ -1506,7 +1506,7 @@
},
{
"source": "/guides/analytics",
"destination": "/analytics/overview"
"destination": "/insights/overview"
},
{
"source": "/guides/assistant",
Expand Down
8 changes: 4 additions & 4 deletions guides/improving-docs.mdx
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
---
title: "Improving your docs"
description: "Use analytics data to make your documentation better"
description: "Use data to make your documentation better"
---

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

## Cross-analytics insights

Combine information from multiple analytics sources to get a holistic view of your documentation.
Combine information from multiple insights 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.

Check warning on line 14 in guides/improving-docs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/improving-docs.mdx#L14

Use 'that's' instead of 'that is'.
- **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.
- **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.

Check warning on line 20 in guides/improving-docs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/improving-docs.mdx#L20

Use 'that's' instead of 'that is'.

Check warning on line 20 in guides/improving-docs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

guides/improving-docs.mdx#L20

In general, use active voice instead of passive voice ('being searched').

## Put insights into action

Use these cross-analytics patterns to prioritize your documentation improvements:
Use these cross-insights 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.
Expand Down
2 changes: 1 addition & 1 deletion analytics/feedback.mdx → insights/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

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).
Access the feedback tab by navigating to the **Insights** page in your [dashboard](https://dashboard.mintlify.com/products/insights).

## Feedback types

Expand Down Expand Up @@ -54,13 +54,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 57 in insights/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/feedback.mdx#L57

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

Check warning on line 57 in insights/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/feedback.mdx#L57

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

Check warning on line 58 in insights/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/feedback.mdx#L58

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 59 in insights/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/feedback.mdx#L59

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

### Filtering 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 63 in insights/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/feedback.mdx#L63

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

Check warning on line 63 in insights/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/feedback.mdx#L63

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

### Adding internal notes

Expand Down
4 changes: 2 additions & 2 deletions analytics/overview.mdx → insights/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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).
Access the overview metrics by navigating to the **Insights** page in your [dashboard](https://dashboard.mintlify.com/products/insights).

## Metrics

Expand All @@ -13,13 +13,13 @@

- **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 insights/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/overview.mdx#L16

Spell out 'CTA', if it's unfamiliar to the audience.
- **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:
Review your overview insights 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.

Check warning on line 24 in insights/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/overview.mdx#L24

Use 'it's' instead of 'it is'.
- **Track traffic trends**: Monitor changes in traffic to understand the impact of updates or new content.
4 changes: 2 additions & 2 deletions analytics/search.mdx → insights/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
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.

Check warning on line 6 in insights/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

insights/search.mdx#L6

In general, use active voice instead of passive voice ('be updated').

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

## Search metrics

Expand All @@ -17,7 +17,7 @@

## Using search data

Review your search analytics to:
Review your search insights 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.
Expand Down