Skip to content

Commit d915557

Browse files
authored
Fixes from feedback on pages (#1840)
* fix formatting * explicitly mention what expanded: false does * update mixpanel integratio page * add note that integration IDs depend on provider * add troubleshooting for preview deployments * note page-specific metatags * explain how MCP servers work
1 parent 1b75301 commit d915557

File tree

7 files changed

+72
-21
lines changed

7 files changed

+72
-21
lines changed

ai/model-context-protocol.mdx

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,20 @@ import { PreviewButton } from "/snippets/previewbutton.jsx"
88

99
## About MCP servers
1010

11-
The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services, like documentation. Mintlify generates an MCP server from your documentation and OpenAPI specifications, preparing your content for the broader AI ecosystem where any MCP client (like Claude, Cursor, Goose, and others) can connect to your documentation and APIs.
11+
The Model Context Protocol (MCP) is an open protocol that creates standardized connections between AI applications and external services, like documentation. Mintlify generates an MCP server from your documentation and OpenAPI specifications, preparing your content for the broader AI ecosystem where any MCP client (like Claude, Cursor, Goose, and others) can connect to your documentation and APIs.
1212

1313
Your MCP server exposes tools for AI applications to search your documentation and interact with your APIs.
1414

15+
### How MCP servers work
16+
17+
When an MCP server is connected to an AI tool, the LLM can decide to use your documentation and API tools during response generation.
18+
19+
- The LLM can proactively search your documentation or call your API endpoints while generating a response, not just when explicitly asked.
20+
- The LLM determines when to use tools based on the context of the conversation and the relevance of your documentation and APIs.
21+
- Each tool call happens during the generation process, allowing the LLM to incorporate real-time information from your documentation and APIs into its response.
22+
23+
For example, if a user asks a coding question and the LLM determines that your API documentation is relevant, it can search your API documentation and include that information in the response without the user explicitly asking about your documentation.
24+
1525
## Accessing your MCP server
1626

1727
<Note>

deploy/preview-deployments.mdx

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,16 @@ By default, preview deployments are publicly accessible to anyone with the URL.
5757
<img src="/images/previews/preview-auth-light.png" alt="The preview authentication toggle in the Add-ons page" className="block dark:hidden" />
5858
<img src="/images/previews/preview-auth-dark.png" alt="The preview authentication toggle in the Add-ons page" className="hidden dark:block" />
5959
</Frame>
60+
61+
## Troubleshooting preview deployments
62+
63+
If your preview deployment fails, try these troubleshooting steps.
64+
65+
- **View the build logs**: In your [dashboard](https://dashboard.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures.
66+
- **Check your configuration**:
67+
- Invalid `docs.json` syntax
68+
- Missing or incorrect file paths referenced in your navigation
69+
- Invalid frontmatter in MDX files
70+
- Broken image links or missing image files
71+
- **Validate locally**: Run `mint dev` locally to catch build errors before pushing to the repository.
72+
- **Check recent changes**: Review the most recent commits in your branch to identify what changes caused the build to fail.

editor.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -110,15 +110,7 @@ Markdown mode provides direct access to the underlying `MDX` code of your docume
110110

111111
Use the sidebar file explorer to browse your documentation files. Click on any file to open it in the editor.
112112

113-
Press <kbd>Command</kbd>
114-
115-
+ <kbd>P</kbd>
116-
117-
on macOS or <kbd>Ctrl</kbd>
118-
119-
+ <kbd>P</kbd>
120-
121-
on Windows to search for files by name.
113+
Press <kbd>Command</kbd> + <kbd>P</kbd> on macOS or <kbd>Ctrl</kbd> + <kbd>P</kbd> on Windows to search for files by name.
122114

123115
### Create new pages
124116

integrations/analytics/mixpanel.mdx

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,21 @@ Add the following to your `docs.json` file to send analytics to Mixpanel.
99
```json Analytics options in docs.json
1010
"integrations": {
1111
"mixpanel": {
12-
"projectToken": "required"
12+
"projectToken": "YOUR_MIXPANEL_PROJECT_TOKEN"
1313
}
1414
}
1515
```
16+
17+
Replace `YOUR_MIXPANEL_PROJECT_TOKEN` with your Mixpanel project token. You can find this in your [Mixpanel project settings](https://mixpanel.com/settings/project).
18+
19+
## Tracked events
20+
21+
Mintlify automatically tracks the following user interactions:
22+
23+
- Page views
24+
- Search queries
25+
- Feedback submissions
26+
- Context menu interactions
27+
- Navigation clicks
28+
29+
If you're not seeing events in Mixpanel, ensure your project token is correct and that no content security policies are blocking the Mixpanel script.

integrations/support/overview.mdx

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,4 @@ horizontal
3838

3939
## Enabling support integrations
4040

41-
Integrate customer support widgets into your documentation. Add the `integrations` field to your `docs.json` file with your respective app ID.
42-
43-
```json
44-
"integrations": {
45-
"intercom": "APP_ID",
46-
"frontchat": "CHAT_ID"
47-
}
48-
```
41+
Integrate customer support widgets into your documentation. Add the `integrations` field to your `docs.json` file with your respective app ID or chat ID. See each integration's documentation for instructions on finding your ID.

optimize/seo.mdx

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,39 @@ If you're using a custom domain, set the `canonical` meta tag to ensure search e
4141

4242
To set page-specific meta tags, add them to a page's frontmatter.
4343

44+
The following meta tags are supported at the page level:
45+
- `title` - Page title
46+
- `description` - Page description appears below the title on the page and in some search engine results
47+
- `keywords` - Comma-separated keywords
48+
- `og:title` - Open Graph title for social sharing
49+
- `og:description` - Open Graph description
50+
- `og:image` - Open Graph image URL
51+
- `og:url` - Open Graph URL
52+
- `og:type` - Open Graph type like "article" or "website"
53+
- `og:image:width` - Open Graph image width
54+
- `og:image:height` - Open Graph image height
55+
- `twitter:title` - Twitter card title
56+
- `twitter:description` - Twitter card description
57+
- `twitter:image` - Twitter card image
58+
- `twitter:card` - Twitter card type like "summary" or "summary_large_image"
59+
- `twitter:site` - Twitter site handle
60+
- `twitter:image:width` - Twitter image width
61+
- `twitter:image:height` - Twitter image height
62+
- `noindex` - Set to `true` to prevent search engine indexing
63+
- `robots` - Robots meta tag value
64+
4465
```mdx
4566
---
4667
title: "Your example page title"
68+
description: "Page-specific description"
4769
"og:image": "link to your meta tag image"
70+
"og:title": "Social media title"
71+
keywords: ["keyword1", "keyword2"]
4872
---
4973
```
5074

5175
<Note>
52-
Meta tags with colons must be wrapped in quotes.
76+
Meta tags with colons must be wrapped in quotes. The `keywords` field must be formatted as a YAML array.
5377
</Note>
5478

5579
## Common meta tags reference

organize/navigation.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,12 @@ In the `navigation` object, `groups` is an array where each entry is an object t
9494

9595
### Default expanded state
9696

97-
Set `expanded: true` on a group to make it expanded by default in the navigation sidebar. This is useful for highlighting important sections or improving discoverability of key content.
97+
Use the `expanded` property to control the default state of a group in the navigation sidebar.
98+
99+
- `expanded: true`: Group is expanded by default.
100+
- `expanded: false` or omitted: Group is collapsed by default.
101+
102+
This is useful for highlighting important sections or improving discoverability of key content.
98103

99104
```json
100105
{

0 commit comments

Comments
 (0)