Skip to content
Draft
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
72 changes: 35 additions & 37 deletions ai/contextual-menu.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Contextual menu"
title: "Context"
description: "Add a contextual menu to your docs with one-click AI integrations for ChatGPT, Claude, Perplexity, Google AI Studio, Devin, Devin Desktop, and MCP tools."
keywords: ["AI tools", "ChatGPT", "Claude", "Perplexity", "MCP", "Grok", "cursor", "vscode", "vs code", "Google AI Studio", "aistudio", "Devin", "Windsurf", "Devin Desktop", "pdf", "copy page", "copy button", "copy markdown", "copy as markdown", "view as markdown", "context menu", "page menu", "AI menu", "AI actions", "open in", "download pdf", "export pdf", "ask ai", "openapi", "download spec"]
---
Expand All @@ -18,7 +18,7 @@ The contextual menu provides quick access to AI-optimized content and direct int
The contextual menu includes several pre-built options that you can enable by adding their identifier to your configuration.

| Option | Identifier | Description |
|:--------|:------------|:-------------|
| :-- | :-- | :-- |
| **Copy page** | `copy` | Copies the current page as Markdown for pasting as context into AI tools |
| **View as Markdown** | `view` | Opens the current page as Markdown |
| **Ask assistant** | `assistant` | Opens the [assistant](/assistant/index) with the current page as context |
Expand All @@ -39,10 +39,7 @@ The contextual menu includes several pre-built options that you can enable by ad
| **Custom options** | Object | Add custom options to the contextual menu |

<Frame>
<img
src="/images/contextual-menu/contextual-menu.png"
alt="The expanded contextual menu showing the Copy page, View as Markdown, Open in ChatGPT, and Open in Claude menu items."
/>
![The expanded contextual menu showing the Copy page, View as Markdown, Open in ChatGPT, and Open in Claude menu items.](/images/contextual-menu/contextual-menu.png)
</Frame>

## Enable the contextual menu
Expand Down Expand Up @@ -88,7 +85,7 @@ By default, the contextual menu appears in the page header. You can configure it
```

| Value | Description |
|:------|:------------|
| :-- | :-- |
| `header` | Displays options in the top-of-page context menu (default) |
| `toc` | Displays options in the table of contents sidebar |

Expand All @@ -108,7 +105,7 @@ Create custom options in the contextual menu by adding an object to the `options

<ResponseField name="href" type="string | object" required>
The href of the option. Use a string for simple links or an object for dynamic links with query parameters.

<Expandable title="href object">
<ResponseField name="base" type="string" required>
The base URL for the option.
Expand All @@ -124,6 +121,7 @@ Create custom options in the contextual menu by adding an object to the `options

<ResponseField name="value" type="string" required>
The query parameter value. Mintlify replaces the following placeholders with the corresponding values:

- Use `$page` to insert the current page content in Markdown.
- Use `$path` to insert the current page path.
- Use `$mcp` to insert the hosted MCP server URL.
Expand All @@ -135,7 +133,7 @@ Create custom options in the contextual menu by adding an object to the `options

Example custom option:

```json {9-14} wrap
```json highlight={9-14} wrap
{
"contextual": {
"options": [
Expand All @@ -158,33 +156,33 @@ Example custom option:
### Custom option examples

<AccordionGroup>
<Accordion title="Simple link">
```json
{
"title": "Request a feature",
"description": "Join the discussion on GitHub",
"icon": "plus",
"href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
}
```
</Accordion>

<Accordion title="Dynamic link with page content">
```json
{
"title": "Share on X",
"description": "Share this page on X",
"icon": "x",
"href": {
"base": "https://x.com/intent/tweet",
"query": [
{
"key": "text",
"value": "Check out this documentation: $page"
<Accordion title="Simple link">
```json
{
"title": "Request a feature",
"description": "Join the discussion on GitHub",
"icon": "plus",
"href": "https://github.com/orgs/mintlify/discussions/categories/feature-requests"
}
```
</Accordion>

<Accordion title="Dynamic link with page content">
```json
{
"title": "Share on X",
"description": "Share this page on X",
"icon": "x",
"href": {
"base": "https://x.com/intent/tweet",
"query": [
{
"key": "text",
"value": "Check out this documentation: $page"
}
]
}
]
}
}
```
</Accordion>
}
```
</Accordion>
</AccordionGroup>
35 changes: 33 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -224,20 +224,51 @@
"root": "assistant/index",
"pages": [
"assistant/configure",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"optimize/seo",
"assistant/customize",
"assistant/skills",
"assistant/use"
]
},
"credits",
"ai/contextual-menu",
"optimize/analytics",
"optimize/feedback",
"ai/llmstxt",
"ai/skillmd",
"ai/model-context-protocol",
"optimize/search",
"optimize/seo",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/contextual-menu",
"ai/markdown-export",
"optimize/pdf-exports",
{
Expand Down
33 changes: 15 additions & 18 deletions optimize/analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
---
title: "Analytics"
description: "Track documentation analytics in the Mintlify dashboard to understand page views, visitor trends, search queries, and content effectiveness."
keywords: ["analytics","metrics","page views","traffic","trends","insights"]
keywords: ["analytics", "metrics", "page views", "traffic", "trends", "insights"]
boost: 3
---

<Info>
Analytics require a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=analytics).
</Info>

The [analytics](https://app.mintlify.com/products/analytics/v2/) page in your dashboard shows data about visitors to your docs, how they interact with the assistant, what they search for, and their feedback. Use this information to identify which pages are most valuable to your users and track trends over time.
The [analytics](https://app.mintlify.com/products/analytics/v2/) page in your dashboard shows data about visitors to your docs, how they interact with the assistan awef awef awef awef awt, what they search for, and their feedback. Use this information to identify which pages are most valuable to your users and track trends over awef awef awef aweftime. awef

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'assistan'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

'awef' is repeated!

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

'awef' is repeated!

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awt'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

'awef' is repeated!

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

'awef' is repeated!

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'aweftime'?

Check warning on line 12 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L12

Did you really mean 'awef'?

## Filter by AI or human visitors

Filter your analytics data by traffic source to analyze AI agent traffic separately from human visitors.

<Frame>
<img
src="/images/analytics/traffic-filter-light.png"
alt="The traffic source filter on the analytics page."
className="block dark:hidden"
src="/images/analytics/traffic-filter-light.png"
/>

<img
src="/images/analytics/traffic-filter-dark.png"
alt="The traffic source filter on the analytics page."
className="hidden dark:block"
src="/images/analytics/traffic-filter-dark.png"
/>
</Frame>

Expand All @@ -37,15 +36,14 @@

<Frame>
<img
src="/images/analytics/range-selector-light.png"
alt="The range selector expanded to show options for viewing different time periods of data."
className="block dark:hidden"
src="/images/analytics/range-selector-light.png"
/>

<img
src="/images/analytics/range-selector-dark.png"
alt="The range selector expanded to show options for viewing different time periods of data."
className="hidden dark:block"
src="/images/analytics/range-selector-dark.png"
/>
</Frame>

Expand Down Expand Up @@ -94,15 +92,14 @@

<Frame>
<img
src="/images/analytics/categories-light.png"
alt="The categories tab in the assistant analytics page."
className="block dark:hidden"
src="/images/analytics/categories-light.png"
/>

<img
src="/images/analytics/categories-dark.png"
alt="The categories tab in the assistant analytics page."
className="hidden dark:block"
src="/images/analytics/categories-dark.png"
/>
</Frame>

Expand All @@ -121,7 +118,7 @@
## Searches

<Note>
The Searches metric is only available when viewing human traffic.
The Searches metric is only available when viewing human traffic.
</Note>

The searches tab displays a bar chart of searches over time and specific queries.
Expand All @@ -135,7 +132,7 @@
## MCP searches

<Note>
The MCP Searches metric is only available when viewing AI traffic.
The MCP Searches metric is only available when viewing AI traffic.
</Note>

The MCP searches tab displays AI agent search interactions through the Model Context Protocol (MCP). This metric counts calls to your MCP server's search tool. It reflects agents that users connected to your MCP server and then issued a search, not general AI crawler traffic to your docs pages.
Expand All @@ -157,10 +154,10 @@
Export any analytics tab to CSV for deeper analysis, reporting, or archival. Exports respect the current traffic source and time range filters.

1. Navigate to the [analytics](https://app.mintlify.com/products/analytics/) page of your dashboard.
1. Click the tab you want to export.
1. Optionally, adjust the traffic source and time range to narrow down the data you want to export.
1. Click **Export to CSV**.
1. Mintlify sends you an email with a download link when the export is ready.
2. Click the tab you want to export.
3. Optionally, adjust the traffic source and time range to narrow down the data you want to export.
4. Click **Export to CSV**.
5. Mintlify sends you an email with a download link when the export is ready.

### Assistant exports

Expand All @@ -172,4 +169,4 @@
- List any queries that had no sources cited.
- Find patterns in unsuccessful interactions.
- Group unanswered queries by topic to prioritize content updates.
</Tip>
</Tip>
Loading