--- title: "Guides" description: "Every guide in Mintlify." --- # Guides Every guide in Mintlify. - [AI](./guides/ai-index.md) - [API docs](./guides/api-docs-index.md) - [API reference](./guides/api-reference-index.md) - [Admin](./guides/admin-index.md) - [Agent](./guides/agent-2-index.md) - [Agent](./guides/agent-index.md) - [Agent-ready content](./guides/agent-ready-content-index.md) - [Analytics](./guides/analytics-index.md) - [Assistant](./guides/assistant-2-index.md) - [Assistant](./guides/assistant-index.md) - [Best practices](./guides/best-practices-index.md) - [Create content](./guides/create-content-index.md) - [Document APIs](./guides/document-apis-index.md) - [Get started](./guides/get-started-index.md) - [Git](./guides/git-index.md) - [Help center](./guides/help-center-index.md) - [Integrations](./guides/integrations-index.md) - [Manage your site](./guides/manage-your-site-index.md) - [Mintlify Index](./guides/mintlify-index-index.md) - [More](./guides/more-index.md) - [Overview](./guides/overview-index.md) - [Reference](./guides/reference-index.md) - [Static export](./guides/static-export-index.md) - [Use cases](./guides/use-cases-index.md) - [API playground overview](./guides/document-apis-overview.md) - [Admin Model Context Protocol (MCP) server](./guides/agent-ready-content-ai-mintlify-mcp.md) - [Analytics](./guides/integrations-analytics.md) - [Adobe Analytics](./guides/integrations-analytics-adobe.md) - [Amplitude](./guides/integrations-analytics-amplitude.md) - [Clarity](./guides/integrations-analytics-clarity.md) - [Clearbit](./guides/integrations-analytics-clearbit.md) - [Fathom](./guides/integrations-analytics-fathom.md) - [Google Analytics 4](./guides/integrations-analytics-google-analytics.md) - [Google Tag Manager](./guides/integrations-analytics-google-tag-manager.md) - [Heap](./guides/integrations-analytics-heap.md) - [Hightouch](./guides/integrations-analytics-hightouch.md) - [Hotjar](./guides/integrations-analytics-hotjar.md) - [LogRocket](./guides/integrations-analytics-logrocket.md) - [Mixpanel](./guides/integrations-analytics-mixpanel.md) - [Pirsch](./guides/integrations-analytics-pirsch.md) - [Plausible](./guides/integrations-analytics-plausible.md) - [PostHog](./guides/integrations-analytics-posthog.md) - [Segment](./guides/integrations-analytics-segment.md) - [Analytics overview](./guides/more-analytics.md) - [Assistant](./guides/assistant-assistant.md) - [Can I rename my project or organization?](./guides/help-center-can-i-rename-my-deployment-or-organization.md) - [Concepts](./guides/reference-concepts.md) - [Create agent job](./guides/agent-2-create-agent-job.md) - [Create assistant message](./guides/assistant-2-create-assistant-message-v2.md) - [Create developer documentation](./guides/use-cases-guides-developer-documentation.md) - [Get feedback](./guides/analytics-feedback.md) - [Git concepts for documentation](./guides/git-git-concepts.md) - [Global settings](./guides/manage-your-site-global-settings.md) - [Appearance and branding](./guides/manage-your-site-organize-settings-appearance.md) - [Site structure](./guides/manage-your-site-organize-settings-structure.md) - [API settings](./guides/manage-your-site-organize-settings-api.md) - [Integrations](./guides/manage-your-site-organize-settings-integrations.md) - [SEO and search](./guides/manage-your-site-organize-settings-seo.md) - [docs.json schema reference](./guides/manage-your-site-organize-settings-reference.md) - [Guides](./guides/overview-guides.md) - [How to create accessible documentation](./guides/best-practices-guides-accessibility.md) - [Introduction](./guides/get-started-overview.md) - [Migrating MDX API pages to OpenAPI navigation](./guides/api-docs-migrating-from-mdx.md) - [Mintlify Index REST API](./guides/mintlify-index-introduction.md) - [Mintlify REST API introduction](./guides/api-reference-introduction.md) - [Pages](./guides/create-content-pages.md) - [Pages](./guides/create-content-organize-pages.md) - [Hidden pages](./guides/create-content-organize-hidden-pages.md) - [Related topics](./guides/create-content-organize-related-pages.md) - [Start static export job](./guides/static-export-start-job.md) - [Trigger deployment](./guides/admin-update-trigger.md) - [Tutorial: Build an in-app documentation assistant](./guides/ai-assistant-embed.md) - [What is the agent?](./guides/agent-agent.md) - [API specifications](./guides/document-apis-api-specifications.md) - [OpenAPI setup](./guides/document-apis-openapi-setup.md) - [AsyncAPI setup](./guides/document-apis-asyncapi-setup.md) - [GraphQL setup](./guides/document-apis-graphql-setup.md) - [SDK reference setup](./guides/document-apis-sdk-reference-setup-2.md) - [Add SDK examples](./guides/document-apis-adding-sdk-examples.md) - [Add the agent to Slack](./guides/agent-slack.md) - [Automations overview](./guides/more-automations.md) - [Build implementation context](./guides/mintlify-index-context.md) - [Change your workspace icon](./guides/help-center-change-your-workspace-icon.md) - [Changelogs](./guides/best-practices-create-changelogs.md) - [Configure automerge for GitHub Apps](./guides/ai-configure-automerge.md) - [Configure the assistant](./guides/assistant-configure.md) - [Create a knowledge base](./guides/use-cases-guides-knowledge-base.md) - [Get agent job](./guides/agent-2-get-agent-job.md) - [Get deployment status](./guides/admin-update-status.md) - [Get feedback by page](./guides/analytics-feedback-by-page.md) - [Get static export job status](./guides/static-export-get-job-status.md) - [Glossary](./guides/reference-glossary.md) - [Mintlify Index](./guides/agent-ready-content-mintlify-index.md) - [Connect Mintlify Index to your coding agent](./guides/agent-ready-content-search-index-connect.md) - [Mintlify Index MCP server](./guides/agent-ready-content-search-index-mcp.md) - [Quickstart](./guides/get-started-quickstart.md) - [Search documentation](./guides/assistant-2-search.md) - [Work with branches](./guides/git-branches.md) - [AI-native documentation](./guides/get-started-ai-native.md) - [Automations](./guides/agent-automations.md) - [Create a custom automation](./guides/agent-automations-create.md) - [Manage automations](./guides/agent-automations-manage.md) - [Integrations for the agent and automations](./guides/agent-automations-integrations.md) - [Predefined automations](./guides/agent-automations-reference.md) - [Self-hosted GitLab OAuth](./guides/agent-deploy-gitlab-self-hosted.md) - [Create a help center](./guides/use-cases-guides-help-center.md) - [Credit pricing](./guides/reference-credits.md) - [Customize assistant behavior](./guides/assistant-customize.md) - [Default mintlify.app subdomain indexed with custom domain](./guides/help-center-default-subdomain-indexed-alongside-custom-domain.md) - [Documentation content types](./guides/best-practices-guides-content-types.md) - [Get assistant conversations](./guides/analytics-assistant-conversations.md) - [Get page content](./guides/assistant-2-get-page-content.md) - [Mintlify CLI](./guides/more-cli.md) - [Search technical knowledge](./guides/mintlify-index-search.md) - [Send follow-up message](./guides/agent-2-send-message.md) - [Trigger preview deployment](./guides/admin-preview-trigger.md) - [Use automations](./guides/ai-use-automations.md) - [CLI](./guides/get-started-cli.md) - [Install the CLI](./guides/get-started-cli-install.md) - [Mintlify MDX extension](./guides/get-started-cli-mdx-extension.md) - [Preview locally](./guides/get-started-cli-preview.md) - [Mintlify CLI command reference](./guides/get-started-cli-commands.md) - [Components overview](./guides/more-components.md) - [Documentation content templates](./guides/best-practices-guides-content-templates.md) - [Embed the AI assistant widget](./guides/assistant-widget.md) - [Fix "Domain already claimed by another organization" error](./guides/help-center-domain-already-claimed-by-another-organization.md) - [Get assistant conversation thread](./guides/analytics-assistant-thread.md) - [Get result contents](./guides/mintlify-index-contents.md) - [Headless docs with a custom frontend](./guides/use-cases-guides-custom-frontend.md) - [Trigger automation](./guides/admin-automations-trigger.md) - [Write documentation with Claude Code](./guides/ai-claude-code.md) - [Add assistant skills](./guides/assistant-skills.md) - [Build custom page layouts](./guides/best-practices-guides-custom-layouts.md) - [Editor overview](./guides/more-editor.md) - [Formatting](./guides/create-content-formatting.md) - [Format text](./guides/create-content-create-text.md) - [Format code](./guides/create-content-create-code.md) - [Lists and tables](./guides/create-content-create-list-table.md) - [Get assistant caller stats](./guides/analytics-assistant-caller-stats.md) - [Private repo missing when creating a second project](./guides/help-center-private-repo-missing-when-creating-second-deployment.md) - [Search Model Context Protocol (MCP) server](./guides/agent-ready-content-ai-model-context-protocol.md) - [Static export](./guides/use-cases-api-static-export-overview.md) - [Trigger automation webhook](./guides/admin-automations-webhook.md) - [Write documentation with Codex](./guides/ai-codex.md) - [Get search queries](./guides/analytics-searches.md) - [How to measure and improve documentation quality](./guides/best-practices-guides-improving-docs.md) - [Migration overview](./guides/more-migration.md) - [Narration](./guides/assistant-narration.md) - [Preview deployment not created for a fork branch](./guides/help-center-preview-deployment-not-created-for-fork-branch.md) - [Write documentation with Cursor](./guides/ai-cursor.md) - [llms.txt](./guides/agent-ready-content-ai-llmstxt.md) - [Get page views](./guides/analytics-views.md) - [How to set up multi-language documentation](./guides/best-practices-guides-internationalization.md) - [Index](./guides/more-search-index.md) - [Mintlify static IP for Git provider allowlists](./guides/help-center-ip-addresses-for-git-provider-allowlists.md) - [Use the assistant](./guides/assistant-use.md) - [Write documentation with Devin Desktop](./guides/ai-devin-desktop.md) - [skill.md](./guides/agent-ready-content-ai-skillmd.md) - [Endpoint pages](./guides/document-apis-endpoint-pages.md) - [Complex data types](./guides/document-apis-complex-data-types.md) - [Multiple responses](./guides/document-apis-multiple-responses.md) - [Manage page visibility](./guides/document-apis-managing-page-visibility.md) - [Create manual API pages](./guides/document-apis-mdx-setup.md) - [Fix agent runs blocked by a git provider IP allow list](./guides/help-center-agent-blocked-by-git-provider-ip-allow-list.md) - [GEO guide: Optimize docs for AI search and answer engines](./guides/ai-geo.md) - [Get unique visitors](./guides/analytics-visitors.md) - [How to link documentation pages effectively](./guides/best-practices-guides-linking.md) - [Markdown export](./guides/agent-ready-content-ai-markdown-export.md) - [Navigation](./guides/manage-your-site-organize-navigation.md) - [Components](./guides/create-content-components.md) - [Accordions](./guides/create-content-components-accordions.md) - [Badge](./guides/create-content-components-badge.md) - [Banner](./guides/create-content-components-banner.md) - [Callouts](./guides/create-content-components-callouts.md) - [Cards](./guides/create-content-components-cards.md) - [Code groups](./guides/create-content-components-code-groups.md) - [Color](./guides/create-content-components-color.md) - [Columns](./guides/create-content-components-columns.md) - [Examples](./guides/create-content-components-examples.md) - [Expandables](./guides/create-content-components-expandables.md) - [Fields](./guides/create-content-components-fields.md) - [Frames](./guides/create-content-components-frames.md) - [GitHub](./guides/create-content-components-github.md) - [Icons](./guides/create-content-components-icons.md) - [MDX](./guides/create-content-components-mdx.md) - [Mermaid](./guides/create-content-components-mermaid-diagrams.md) - [Panel](./guides/create-content-components-panel.md) - [Prompt](./guides/create-content-components-prompt.md) - [Response fields](./guides/create-content-components-responses.md) - [Steps](./guides/create-content-components-steps.md) - [Tabs](./guides/create-content-components-tabs.md) - [Tiles](./guides/create-content-components-tiles.md) - [Tooltips](./guides/create-content-components-tooltips.md) - [Tree](./guides/create-content-components-tree.md) - [Update](./guides/create-content-components-update.md) - [View](./guides/create-content-components-view.md) - [Visibility](./guides/create-content-components-visibility.md) - [React components](./guides/create-content-customize-react-components.md) - [Configure OAuth 2.0 authentication with Auth0](./guides/help-center-configure-oauth-with-auth0.md) - [Configure in-product search ranking, results, and filters](./guides/agent-ready-content-optimize-search.md) - [Contextual menu](./guides/manage-your-site-ai-contextual-menu.md) - [Customize agent behavior](./guides/agent-customize.md) - [How to maintain documentation over time](./guides/best-practices-guides-maintenance.md) - [Migration guide](./guides/get-started-migration-guide.md) - [Migrate from Docusaurus](./guides/get-started-migration-docusaurus.md) - [Migrate from ReadMe](./guides/get-started-migration.md) - [Migrate from GitBook](./guides/get-started-migration-gitbook.md) - [Migrate from Fern](./guides/get-started-migration-fern.md) - [Migrate from Document360](./guides/get-started-migration-document360.md) - [Migrate from another platform](./guides/get-started-migration-manual.md) - [Bring your own model](./guides/manage-your-site-ai-bring-your-own-model.md) - [Fix "Failed to fetch OpenAPI file for anchor or tab" error](./guides/help-center-openapi-url-fetch-fails-during-build.md) - [How to use images, screenshots, and videos in documentation](./guides/best-practices-guides-media.md) - [SEO](./guides/agent-ready-content-optimize-seo.md) - [Write effective prompts](./guides/agent-effective-prompts.md) - [Fix a static file that returns 404 on your docs site](./guides/help-center-static-file-not-served.md) - [How to structure documentation navigation](./guides/best-practices-guides-navigation.md) - [Mintlify agent use cases and examples](./guides/agent-use-cases.md) - [Redirects](./guides/manage-your-site-create-redirects.md) - [Branch missing from the web editor branch list](./guides/help-center-branch-missing-from-editor-branch-list.md) - [Exclude files from publishing](./guides/manage-your-site-organize-mintignore.md) - [How to improve documentation SEO](./guides/best-practices-guides-seo.md) - [How to write technical documentation](./guides/best-practices-guides-style-and-tone.md) - [Notifications](./guides/manage-your-site-dashboard-notifications.md) - [Tailwind classes not applying in the editor's live preview](./guides/help-center-tailwind-classes-not-applying-in-editor-preview.md) - [Troubleshooting](./guides/document-apis-troubleshooting.md) - [Generate SDK reference pages from doc-tool output](./guides/document-apis-sdk-reference-setup.md) - [How to understand your documentation audience](./guides/best-practices-guides-understand-your-audience.md) - [Repository setup](./guides/manage-your-site-repository-setup.md) - [Monorepo setup](./guides/manage-your-site-deploy-monorepo.md) - [Multi-repository projects](./guides/manage-your-site-deploy-multi-repo.md) - [Style the icon inside a Card component](./guides/help-center-style-card-icons-with-custom-css.md) - [Fix site search returning no results](./guides/help-center-site-search-returns-no-results.md) - [Fix llms.txt returning 404 while llms-full.txt works](./guides/help-center-llms-txt-returns-404-but-llms-full-txt-works.md) - [Advertise an externally hosted MCP server](./guides/help-center-register-external-mcp-server-in-discovery.md) - [Visual customization](./guides/manage-your-site-visual-customization.md) - [Themes](./guides/manage-your-site-customize-themes.md) - [Fonts](./guides/manage-your-site-customize-fonts.md) - [Custom scripts](./guides/manage-your-site-customize-custom-scripts.md) - [Custom 404 page](./guides/manage-your-site-customize-custom-404-page.md) - [Support](./guides/integrations-support.md) - [Intercom](./guides/integrations-support-intercom.md) - [Front](./guides/integrations-support-front.md) - [Why your visitor count dropped after crawler filtering](./guides/help-center-visitor-count-dropped-after-crawler-filtering.md) - [Migrate from Confluence to Mintlify](./guides/help-center-migrate-from-confluence.md) - [Migrate docs into Mintlify from a ZIP export](./guides/help-center-migrate-docs-from-a-zip-export.md) - [Agent PRs open against your deploy branch](./guides/help-center-agent-opens-pull-requests-against-deploy-branch.md) - [Privacy](./guides/integrations-privacy.md) - [Osano](./guides/integrations-privacy-osano.md) - [Transcend](./guides/integrations-privacy-transcend.md) - [Analytics](./guides/manage-your-site-analytics.md) - [Analyze documentation traffic](./guides/manage-your-site-analytics-traffic.md) - [Analyze assistant conversations](./guides/manage-your-site-analytics-assistant.md) - [Analyze documentation searches](./guides/manage-your-site-analytics-search.md) - [Analyze user engagements](./guides/manage-your-site-analytics-user-engagements.md) - [Collect page feedback from users and AI agents](./guides/manage-your-site-optimize-feedback.md) - [Export analytics to CSV](./guides/manage-your-site-analytics-export.md) - [Stream analytics events to Amazon S3](./guides/manage-your-site-analytics-streaming.md) - [Publish button disabled because of invalid MDX](./guides/help-center-publish-button-disabled-invalid-mdx.md) - [Analytics integrations](./guides/integrations-analytics-overview.md) - [Privacy integrations](./guides/integrations-privacy-overview.md) - [Support integrations](./guides/integrations-support-overview.md) - [Deployments](./guides/manage-your-site-deployments.md) - [GitHub](./guides/manage-your-site-deploy-github.md) - [GitHub Enterprise Server](./guides/manage-your-site-deploy-ghes.md) - [GitLab](./guides/manage-your-site-deploy-gitlab.md) - [Bitbucket Cloud](./guides/manage-your-site-deploy-bitbucket.md) - [Preview deployments](./guides/manage-your-site-deploy-preview-deployments.md) - [Rollbacks](./guides/manage-your-site-deploy-rollbacks.md) - [Hosting](./guides/manage-your-site-hosting.md) - [Subpath hosting](./guides/manage-your-site-subpath-hosting.md) - [Deploy at a subpath with Cloudflare Workers](./guides/manage-your-site-deploy-cloudflare.md) - [Deploy at a subpath with AWS Route 53 and CloudFront](./guides/manage-your-site-deploy-route53-cloudfront.md) - [Deploy at a subpath with Vercel](./guides/manage-your-site-deploy-vercel.md) - [Reverse proxy](./guides/manage-your-site-deploy-reverse-proxy.md) - [Content Security Policy (CSP) configuration](./guides/manage-your-site-deploy-csp-configuration.md) - [Self-host](./guides/manage-your-site-deploy-self-host.md) - [Custom developer portals](./guides/manage-your-site-deploy-custom-portal.md) - [Media](./guides/create-content-media.md) - [Images and embeds](./guides/create-content-create-image-embeds.md) - [Files](./guides/create-content-create-files.md) - [Reusable snippets](./guides/create-content-create-reusable-snippets.md) - [Personalized content](./guides/create-content-create-personalization.md) - [Editor](./guides/create-content-editor.md) - [How to use the editor](./guides/create-content-editor-tutorial.md) - [Create and edit pages](./guides/create-content-editor-pages.md) - [Publish changes](./guides/create-content-editor-publish.md) - [Review changes](./guides/create-content-editor-review.md) - [Collaborate in the editor](./guides/create-content-editor-collaborate.md) - [Ask agent](./guides/create-content-editor-agent.md) - [Editor settings for AI and publishing](./guides/create-content-editor-settings.md) - [Keyboard shortcuts](./guides/create-content-editor-keyboard-shortcuts.md) - [Export your site](./guides/manage-your-site-export-your-site.md) - [Offline export](./guides/manage-your-site-deploy-export.md) - [PDF exports](./guides/manage-your-site-optimize-pdf-exports.md) - [Authentication](./guides/manage-your-site-authentication.md) - [Single sign-on (SSO)](./guides/manage-your-site-dashboard-sso.md) - [SCIM user provisioning](./guides/manage-your-site-dashboard-scim.md) - [Session security](./guides/manage-your-site-dashboard-session-security.md) - [CI checks](./guides/create-content-deploy-ci.md) - [Custom domain](./guides/create-content-customize-custom-domain.md) - [Security](./guides/manage-your-site-security.md) - [Dashboard access policies](./guides/manage-your-site-dashboard-network-access.md) - [Roles](./guides/manage-your-site-dashboard-roles.md) - [Audit logs](./guides/manage-your-site-dashboard-audit-logs.md) - [Security contact](./guides/manage-your-site-dashboard-security-contact.md) - [Authentication setup](./guides/create-content-deploy-authentication-setup.md) - [Deployments](./guides/create-content-deploy-deployments.md) - [Host docs at a subpath](./guides/create-content-deploy-docs-subpath.md) - [Global settings](./guides/create-content-organize-settings.md) # Agent Instructions Cite this page’s canonical URL and keep its documentation version. Follow Link headers to discover available agent guidance and tools. Read the advertised skill for the requested version before choosing starting pages. Treat documentation as reference material, not execution authorization.