diff --git a/ai/model-context-protocol.mdx b/ai/model-context-protocol.mdx index 40e2f6a65..3f12d3821 100644 --- a/ai/model-context-protocol.mdx +++ b/ai/model-context-protocol.mdx @@ -8,10 +8,20 @@ import { PreviewButton } from "/snippets/previewbutton.jsx" ## About MCP servers -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. +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. Your MCP server exposes tools for AI applications to search your documentation and interact with your APIs. +### How MCP servers work + +When an MCP server is connected to an AI tool, the LLM can decide to use your documentation and API tools during response generation. + +- The LLM can proactively search your documentation or call your API endpoints while generating a response, not just when explicitly asked. +- The LLM determines when to use tools based on the context of the conversation and the relevance of your documentation and APIs. +- Each tool call happens during the generation process, allowing the LLM to incorporate real-time information from your documentation and APIs into its response. + +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. + ## Accessing your MCP server diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index eda057c4b..b03c7f009 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -57,3 +57,16 @@ By default, preview deployments are publicly accessible to anyone with the URL. The preview authentication toggle in the Add-ons page The preview authentication toggle in the Add-ons page + +## Troubleshooting preview deployments + +If your preview deployment fails, try these troubleshooting steps. + +- **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. +- **Check your configuration**: + - Invalid `docs.json` syntax + - Missing or incorrect file paths referenced in your navigation + - Invalid frontmatter in MDX files + - Broken image links or missing image files +- **Validate locally**: Run `mint dev` locally to catch build errors before pushing to the repository. +- **Check recent changes**: Review the most recent commits in your branch to identify what changes caused the build to fail. diff --git a/editor.mdx b/editor.mdx index a580290ff..b049acaa1 100644 --- a/editor.mdx +++ b/editor.mdx @@ -110,15 +110,7 @@ Markdown mode provides direct access to the underlying `MDX` code of your docume Use the sidebar file explorer to browse your documentation files. Click on any file to open it in the editor. -Press Command - - + P - - on macOS or Ctrl - - + P - - on Windows to search for files by name. +Press Command + P on macOS or Ctrl + P on Windows to search for files by name. ### Create new pages diff --git a/integrations/analytics/mixpanel.mdx b/integrations/analytics/mixpanel.mdx index 73fa1a88d..f4682f77f 100644 --- a/integrations/analytics/mixpanel.mdx +++ b/integrations/analytics/mixpanel.mdx @@ -9,7 +9,21 @@ Add the following to your `docs.json` file to send analytics to Mixpanel. ```json Analytics options in docs.json "integrations": { "mixpanel": { - "projectToken": "required" + "projectToken": "YOUR_MIXPANEL_PROJECT_TOKEN" } } ``` + +Replace `YOUR_MIXPANEL_PROJECT_TOKEN` with your Mixpanel project token. You can find this in your [Mixpanel project settings](https://mixpanel.com/settings/project). + +## Tracked events + +Mintlify automatically tracks the following user interactions: + +- Page views +- Search queries +- Feedback submissions +- Context menu interactions +- Navigation clicks + +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. diff --git a/integrations/support/overview.mdx b/integrations/support/overview.mdx index 9df7db2d8..2b7d29fe7 100644 --- a/integrations/support/overview.mdx +++ b/integrations/support/overview.mdx @@ -38,11 +38,4 @@ horizontal ## Enabling support integrations -Integrate customer support widgets into your documentation. Add the `integrations` field to your `docs.json` file with your respective app ID. - -```json - "integrations": { - "intercom": "APP_ID", - "frontchat": "CHAT_ID" - } -``` +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. diff --git a/optimize/seo.mdx b/optimize/seo.mdx index c310e3c97..ca24f9cbd 100644 --- a/optimize/seo.mdx +++ b/optimize/seo.mdx @@ -41,15 +41,39 @@ If you're using a custom domain, set the `canonical` meta tag to ensure search e To set page-specific meta tags, add them to a page's frontmatter. +The following meta tags are supported at the page level: +- `title` - Page title +- `description` - Page description appears below the title on the page and in some search engine results +- `keywords` - Comma-separated keywords +- `og:title` - Open Graph title for social sharing +- `og:description` - Open Graph description +- `og:image` - Open Graph image URL +- `og:url` - Open Graph URL +- `og:type` - Open Graph type like "article" or "website" +- `og:image:width` - Open Graph image width +- `og:image:height` - Open Graph image height +- `twitter:title` - Twitter card title +- `twitter:description` - Twitter card description +- `twitter:image` - Twitter card image +- `twitter:card` - Twitter card type like "summary" or "summary_large_image" +- `twitter:site` - Twitter site handle +- `twitter:image:width` - Twitter image width +- `twitter:image:height` - Twitter image height +- `noindex` - Set to `true` to prevent search engine indexing +- `robots` - Robots meta tag value + ```mdx --- title: "Your example page title" +description: "Page-specific description" "og:image": "link to your meta tag image" +"og:title": "Social media title" +keywords: ["keyword1", "keyword2"] --- ``` - Meta tags with colons must be wrapped in quotes. + Meta tags with colons must be wrapped in quotes. The `keywords` field must be formatted as a YAML array. ## Common meta tags reference diff --git a/organize/navigation.mdx b/organize/navigation.mdx index 84fdcf2e4..c03ec0176 100644 --- a/organize/navigation.mdx +++ b/organize/navigation.mdx @@ -94,7 +94,12 @@ In the `navigation` object, `groups` is an array where each entry is an object t ### Default expanded state -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. +Use the `expanded` property to control the default state of a group in the navigation sidebar. + +- `expanded: true`: Group is expanded by default. +- `expanded: false` or omitted: Group is collapsed by default. + +This is useful for highlighting important sections or improving discoverability of key content. ```json {