From a9de63ab4eb2a5a36b4602104b8811b900d4df36 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 2 May 2026 03:14:51 +0000 Subject: [PATCH] Audit and improve SEO frontmatter across docs Generated-By: mintlify-agent --- agent/index.mdx | 2 +- api/agent/create-agent-job.mdx | 2 +- api/agent/get-agent-job.mdx | 2 +- api/agent/get-all-jobs.mdx | 2 +- api/agent/v2/create-agent-job.mdx | 2 +- api/agent/v2/get-agent-job.mdx | 2 +- api/agent/v2/send-message.mdx | 2 +- api/analytics/assistant-caller-stats.mdx | 2 +- api/analytics/assistant-conversations.mdx | 2 +- api/analytics/feedback-by-page.mdx | 2 +- api/analytics/feedback.mdx | 2 +- api/analytics/searches.mdx | 2 +- api/analytics/views.mdx | 2 +- api/analytics/visitors.mdx | 2 +- api/assistant/create-assistant-message-v2.mdx | 2 +- api/assistant/create-assistant-message.mdx | 2 +- api/assistant/get-page-content.mdx | 2 +- api/assistant/search.mdx | 2 +- api/preview/trigger.mdx | 2 +- api/update/status.mdx | 2 +- api/update/trigger.mdx | 2 +- components/cards.mdx | 2 +- editor-classic.mdx | 2 +- editor/collaborate.mdx | 2 +- editor/configurations.mdx | 2 +- editor/index.mdx | 2 +- editor/live-preview.mdx | 2 +- editor/navigation.mdx | 2 +- editor/pages.mdx | 2 +- editor/share-a-preview.mdx | 2 +- editor/tutorial.mdx | 2 +- optimize/search-boost.mdx | 2 +- workflows/create.mdx | 2 +- workflows/enable.mdx | 2 +- workflows/index.mdx | 2 +- workflows/manage.mdx | 2 +- 36 files changed, 36 insertions(+), 36 deletions(-) diff --git a/agent/index.mdx b/agent/index.mdx index 2ab9144b2..179be5d8f 100644 --- a/agent/index.mdx +++ b/agent/index.mdx @@ -1,6 +1,6 @@ --- title: "What is the agent?" -description: "Automate documentation updates with the Mintlify agent. Trigger changes from Slack messages, pull requests, or API calls." +description: "Learn how the Mintlify agent researches, plans, and writes documentation, then opens pull requests with proposed changes for your team to review." keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] --- diff --git a/api/agent/create-agent-job.mdx b/api/agent/create-agent-job.mdx index ab24f3a37..6d0e1a141 100644 --- a/api/agent/create-agent-job.mdx +++ b/api/agent/create-agent-job.mdx @@ -1,9 +1,9 @@ --- title: "Create agent job (v1)" -description: "Deprecated. Create an agent job to automate documentation updates, with automatic branch creation and pull request generation." openapi: /admin-openapi.json POST /v1/agent/{projectId}/job keywords: [ "agent job", "create", "automation", "automate" ] tag: "deprecated" + --- This endpoint is deprecated. Use the [v2 create agent job](/api/agent/v2/create-agent-job) endpoint instead. diff --git a/api/agent/get-agent-job.mdx b/api/agent/get-agent-job.mdx index 1c6526e56..a1ef4d92a 100644 --- a/api/agent/get-agent-job.mdx +++ b/api/agent/get-agent-job.mdx @@ -1,9 +1,9 @@ --- title: "Get agent job (v1)" -description: "Deprecated. Retrieve the status and details of a specific agent job, including progress, branch info, and pull request details." openapi: /admin-openapi.json GET /v1/agent/{projectId}/job/{id} keywords: [ "agent job", "status", "retrieve", "details" ] tag: "deprecated" + --- This endpoint is deprecated. Use the [v2 get agent job](/api/agent/v2/get-agent-job) endpoint instead. diff --git a/api/agent/get-all-jobs.mdx b/api/agent/get-all-jobs.mdx index 833bed5ec..ab12075b4 100644 --- a/api/agent/get-all-jobs.mdx +++ b/api/agent/get-all-jobs.mdx @@ -1,9 +1,9 @@ --- title: "List agent jobs (v1)" -description: "Deprecated. Retrieve all agent jobs for a project to monitor activities and track historical job statuses." openapi: /admin-openapi.json GET /v1/agent/{projectId}/jobs keywords: [ "agent jobs", "list", "monitoring" ] tag: "deprecated" + --- This endpoint is deprecated. Use the [v2 get agent job](/api/agent/v2/get-agent-job) endpoint instead. diff --git a/api/agent/v2/create-agent-job.mdx b/api/agent/v2/create-agent-job.mdx index 75e146e18..b48a847d4 100644 --- a/api/agent/v2/create-agent-job.mdx +++ b/api/agent/v2/create-agent-job.mdx @@ -1,8 +1,8 @@ --- title: "Create agent job" -description: "Create an agent job that runs in the background and automatically creates a pull request with documentation changes." openapi: /admin-openapi.json POST /v2/agent/{projectId}/job keywords: ["agent job", "create", "automation", "automate"] + --- This endpoint creates a background agent job. The job runs asynchronously — use the [get agent job](/api/agent/v2/get-agent-job) endpoint to poll for status updates. diff --git a/api/agent/v2/get-agent-job.mdx b/api/agent/v2/get-agent-job.mdx index f4db4ef63..ecae62342 100644 --- a/api/agent/v2/get-agent-job.mdx +++ b/api/agent/v2/get-agent-job.mdx @@ -1,8 +1,8 @@ --- title: "Get agent job" -description: "Retrieve the status and details of an agent job, including progress and pull request link." openapi: /admin-openapi.json GET /v2/agent/{projectId}/job/{id} keywords: ["agent job", "status", "retrieve", "details", "poll"] + --- Poll this endpoint to track the progress of an agent job. The `status` field transitions through `active` → `completed` or `failed`. diff --git a/api/agent/v2/send-message.mdx b/api/agent/v2/send-message.mdx index 5971d56f5..abbc26e36 100644 --- a/api/agent/v2/send-message.mdx +++ b/api/agent/v2/send-message.mdx @@ -1,8 +1,8 @@ --- title: "Send follow-up message" -description: "Send a follow-up message to an existing agent job to provide additional instructions." openapi: /admin-openapi.json POST /v2/agent/{projectId}/job/{id}/message keywords: ["agent job", "message", "follow-up", "send"] + --- Send a follow-up instruction to an existing agent job. The message is processed asynchronously — poll the [get agent job](/api/agent/v2/get-agent-job) endpoint to track progress. diff --git a/api/analytics/assistant-caller-stats.mdx b/api/analytics/assistant-caller-stats.mdx index cd9527863..5a4902688 100644 --- a/api/analytics/assistant-caller-stats.mdx +++ b/api/analytics/assistant-caller-stats.mdx @@ -1,8 +1,8 @@ --- title: "Get assistant caller stats" -description: "Retrieve a breakdown of assistant query counts by caller type for a given date range." openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant/caller-stats keywords: ["analytics", "assistant", "caller", "stats", "export"] + --- ## Usage diff --git a/api/analytics/assistant-conversations.mdx b/api/analytics/assistant-conversations.mdx index 44b77777a..14c33ae96 100644 --- a/api/analytics/assistant-conversations.mdx +++ b/api/analytics/assistant-conversations.mdx @@ -1,8 +1,8 @@ --- title: "Get assistant conversations" -description: "Retrieve AI assistant conversation history including queries, responses, cited sources, resolution status, and categories." openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/assistant keywords: ["analytics", "assistant", "conversations", "export", "AI"] + --- ## Usage diff --git a/api/analytics/feedback-by-page.mdx b/api/analytics/feedback-by-page.mdx index 38cc6f620..02a299f4e 100644 --- a/api/analytics/feedback-by-page.mdx +++ b/api/analytics/feedback-by-page.mdx @@ -1,8 +1,8 @@ --- title: "Get feedback by page" -description: "Retrieve user feedback counts aggregated by documentation page, including thumbs up/down ratings and code snippet feedback." openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback/by-page keywords: ["analytics", "feedback", "export", "by page", "aggregated"] + --- ## Usage diff --git a/api/analytics/feedback.mdx b/api/analytics/feedback.mdx index ae028311a..cffca87ea 100644 --- a/api/analytics/feedback.mdx +++ b/api/analytics/feedback.mdx @@ -1,8 +1,8 @@ --- title: "Get feedback" -description: "Retrieve user feedback from your documentation, including page ratings and code snippet feedback." openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/feedback keywords: ["analytics", "feedback", "export", "user feedback"] + --- ## Usage diff --git a/api/analytics/searches.mdx b/api/analytics/searches.mdx index 5cda5ca54..33dfb889c 100644 --- a/api/analytics/searches.mdx +++ b/api/analytics/searches.mdx @@ -1,8 +1,8 @@ --- title: "Get search queries" -description: "Retrieve documentation search terms with hit counts, click-through rates, and top clicked pages." openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/searches keywords: ["analytics", "search", "export", "queries", "search terms"] + --- ## Usage diff --git a/api/analytics/views.mdx b/api/analytics/views.mdx index 599f5e949..cdb50bfea 100644 --- a/api/analytics/views.mdx +++ b/api/analytics/views.mdx @@ -1,8 +1,8 @@ --- title: "Get page views" -description: "Retrieve per-page and site-wide content view counts, split by human and AI traffic." openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/views keywords: ["analytics", "views", "page views", "traffic", "export"] + --- ## Usage diff --git a/api/analytics/visitors.mdx b/api/analytics/visitors.mdx index b00949c0c..5efb33565 100644 --- a/api/analytics/visitors.mdx +++ b/api/analytics/visitors.mdx @@ -1,8 +1,8 @@ --- title: "Get unique visitors" -description: "Retrieve per-page and site-wide approximate unique visitor counts, split by human and AI traffic." openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/visitors keywords: ["analytics", "visitors", "unique visitors", "traffic", "export"] + --- ## Usage diff --git a/api/assistant/create-assistant-message-v2.mdx b/api/assistant/create-assistant-message-v2.mdx index 606d628b3..70e10228a 100644 --- a/api/assistant/create-assistant-message-v2.mdx +++ b/api/assistant/create-assistant-message-v2.mdx @@ -1,6 +1,5 @@ --- title: "Create assistant message" -description: "Send messages to the AI assistant and receive streaming responses using AI SDK v5 or later with the useChat hook." openapi: /discovery-openapi.json POST /v2/assistant/{domain}/message keywords: [ @@ -12,6 +11,7 @@ keywords: "ai sdk v5", "ai sdk v6", ] + --- diff --git a/api/assistant/create-assistant-message.mdx b/api/assistant/create-assistant-message.mdx index 977dd0242..c040be75e 100644 --- a/api/assistant/create-assistant-message.mdx +++ b/api/assistant/create-assistant-message.mdx @@ -1,9 +1,9 @@ --- title: "Create assistant message (v1)" -description: "Deprecated. Send messages to the AI assistant using AI SDK v4. Use v2 endpoint for AI SDK v5 or later." openapi: /discovery-openapi.json POST /v1/assistant/{domain}/message tag: "Deprecated" keywords: [ "assistant message", "embed", "chat", "integrate", "ai sdk v4" ] + --- Deprecated diff --git a/api/assistant/get-page-content.mdx b/api/assistant/get-page-content.mdx index b958465da..e64e3772c 100644 --- a/api/assistant/get-page-content.mdx +++ b/api/assistant/get-page-content.mdx @@ -1,8 +1,8 @@ --- title: "Get page content" -description: "Retrieve the full text content of a documentation page by its path." openapi: "/discovery-openapi.json POST /v1/page/{domain}" keywords: [ "page", "content", "retrieve" ] + --- ## Rate limits diff --git a/api/assistant/search.mdx b/api/assistant/search.mdx index df9a1451d..c1b048a4f 100644 --- a/api/assistant/search.mdx +++ b/api/assistant/search.mdx @@ -1,8 +1,8 @@ --- title: "Search documentation" -description: "Search your documentation programmatically and retrieve relevant pages matching the query." openapi: "/discovery-openapi.json POST /v1/search/{domain}" keywords: [ "search", "query" ] + --- ## Rate limits diff --git a/api/preview/trigger.mdx b/api/preview/trigger.mdx index 47e526bd8..aa5a76d05 100644 --- a/api/preview/trigger.mdx +++ b/api/preview/trigger.mdx @@ -1,8 +1,8 @@ --- title: "Trigger preview deployment" -description: "Create or update a preview deployment for a specific branch to review documentation changes before merging to production." openapi: "/openapi.json POST /project/preview/{projectId}" keywords: ["preview", "preview deployment", "branch preview", "staging"] + --- diff --git a/api/update/status.mdx b/api/update/status.mdx index a771841e1..b7c9ba75b 100644 --- a/api/update/status.mdx +++ b/api/update/status.mdx @@ -1,6 +1,6 @@ --- title: "Get deployment status" -description: "Check the status of a documentation deployment to monitor progress and completion." openapi: "/openapi.json GET /project/update-status/{statusId}" keywords: [ "update status", "deployment status", "check status" ] + --- diff --git a/api/update/trigger.mdx b/api/update/trigger.mdx index 0d4419e9c..44fe1c86f 100644 --- a/api/update/trigger.mdx +++ b/api/update/trigger.mdx @@ -1,6 +1,6 @@ --- title: "Trigger deployment" -description: "Trigger a documentation deployment programmatically to publish updates outside of Git workflows." openapi: "/openapi.json POST /project/update/{projectId}" keywords: [ "trigger", "update", "deployment", "programmatic" ] + --- diff --git a/components/cards.mdx b/components/cards.mdx index 9964ef71b..804355e98 100644 --- a/components/cards.mdx +++ b/components/cards.mdx @@ -1,6 +1,6 @@ --- title: "Cards" -description: "Use card components to display links, icons, images, and grouped content as visual containers that organize navigation." +description: "Use the Mintlify Card component to display links, icons, images, and grouped content as visual containers, including horizontal layouts and CardGroup grids." keywords: ["cards", "visual containers"] --- diff --git a/editor-classic.mdx b/editor-classic.mdx index eb7178794..7590f8f66 100644 --- a/editor-classic.mdx +++ b/editor-classic.mdx @@ -1,6 +1,6 @@ --- title: "Web editor" -description: "The classic Mintlify web editor for creating and publishing documentation in your browser. Sunsetting May 7, 2026." +description: "The classic Mintlify web editor for creating and publishing documentation in your browser. Deprecating on May 7, 2026 — migrate to the new editor." keywords: ["editor", "visual editor", "web editor"] tag: "Classic" --- diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index f6d8ad36b..36890a1ac 100644 --- a/editor/collaborate.mdx +++ b/editor/collaborate.mdx @@ -1,7 +1,7 @@ --- title: "Collaborate in the web editor" sidebarTitle: "Collaborate" -description: "Edit documentation simultaneously with your team using real-time collaboration, live cursors, and branch-based workflows." +description: "Edit documentation with your team using real-time collaboration, live cursors, shareable editor links, branches, and pull request review workflows." keywords: ["editor", "collaboration", "real-time", "live editing", "branches", "pull requests", "preview deployments", "share links"] --- diff --git a/editor/configurations.mdx b/editor/configurations.mdx index cdbcbcc44..bf2eff40b 100644 --- a/editor/configurations.mdx +++ b/editor/configurations.mdx @@ -1,6 +1,6 @@ --- title: "Configurations" -description: "Edit site branding, appearance, and feature settings using the visual configuration sheet in the Mintlify web editor." +description: "Edit site branding, colors, appearance, and feature settings from the Configurations panel in the Mintlify web editor, with real-time team sync." keywords: ["editor", "configurations", "settings", "branding", "theme"] --- diff --git a/editor/index.mdx b/editor/index.mdx index 1c367a9ba..7f4b846ac 100644 --- a/editor/index.mdx +++ b/editor/index.mdx @@ -1,7 +1,7 @@ --- title: "Editor overview" sidebarTitle: "Overview" -description: "Create, edit, and publish content directly in your browser with real-time collaboration, automatic saving, and Git sync." +description: "Create, edit, and publish documentation in your browser with real-time team collaboration, automatic saving, live previews, and continuous Git sync." keywords: ["editor", "visual", "collaborative", "web editor"] --- diff --git a/editor/live-preview.mdx b/editor/live-preview.mdx index d97bb0f28..881153291 100644 --- a/editor/live-preview.mdx +++ b/editor/live-preview.mdx @@ -1,6 +1,6 @@ --- title: "Live preview" -description: "Preview changes to your site in real time as you edit, with continuous updates and responsive viewport options." +description: "Preview your documentation site in real time as you edit, with continuous updates that render content, navigation, and configuration changes instantly." keywords: ["editor", "preview", "live preview"] --- diff --git a/editor/navigation.mdx b/editor/navigation.mdx index b29b42009..2c1894be9 100644 --- a/editor/navigation.mdx +++ b/editor/navigation.mdx @@ -1,6 +1,6 @@ --- title: "Organize navigation" -description: "Reorder pages and manage your documentation site structure using drag-and-drop in the Mintlify web editor." +description: "Reorder pages, add groups, and manage your documentation sidebar structure using drag-and-drop in the Mintlify web editor — no docs.json edits needed." keywords: ["editor", "navigation", "sidebar", "structure"] --- diff --git a/editor/pages.mdx b/editor/pages.mdx index 5427829f5..d087f1014 100644 --- a/editor/pages.mdx +++ b/editor/pages.mdx @@ -1,6 +1,6 @@ --- title: "Create and edit pages" -description: "Create pages, edit content, upload media, and manage files in the Mintlify editor." +description: "Create pages, edit content, upload images and video, and manage files in the Mintlify web editor with rich-text editing and search across your docs." keywords: ["editor", "content", "pages", "files", "create", "edit", "media", "images", "video"] --- diff --git a/editor/share-a-preview.mdx b/editor/share-a-preview.mdx index 96e3a90f6..4fbc5f4fd 100644 --- a/editor/share-a-preview.mdx +++ b/editor/share-a-preview.mdx @@ -1,6 +1,6 @@ --- title: "Share a preview" -description: "Share preview deployments and editor links to gather feedback on documentation changes before publishing." +description: "Share preview deployment URLs and editor links from your feature branch to gather feedback and review documentation changes before publishing them live." keywords: ["editor", "preview", "preview deployment", "share", "collaboration", "feedback"] --- diff --git a/editor/tutorial.mdx b/editor/tutorial.mdx index 006728914..c2d8ad613 100644 --- a/editor/tutorial.mdx +++ b/editor/tutorial.mdx @@ -1,6 +1,6 @@ --- title: "How to use the editor" -description: "A complete walkthrough of the editor workflow: create a branch, edit pages, preview your changes, and publish." +description: "Step-by-step walkthrough of the Mintlify editor: create a branch, edit pages, share a preview deployment for review, and publish your documentation changes." keywords: ["editor", "tutorial", "branch", "publish"] --- diff --git a/optimize/search-boost.mdx b/optimize/search-boost.mdx index 3c3973ea8..e14b636cc 100644 --- a/optimize/search-boost.mdx +++ b/optimize/search-boost.mdx @@ -1,6 +1,6 @@ --- title: "Search boost" -description: "Bias your documentation site's in-product search ranking toward specific pages or sections by setting a boost multiplier in frontmatter or your `docs.json` navigation." +description: "Bias your in-product documentation search ranking toward specific pages or sections using the boost multiplier in frontmatter or in docs.json navigation." keywords: ["search ranking", "search boost", "boost", "search prioritization"] --- diff --git a/workflows/create.mdx b/workflows/create.mdx index f8b994ee0..48c6a0a6f 100644 --- a/workflows/create.mdx +++ b/workflows/create.mdx @@ -1,6 +1,6 @@ --- title: "Create a custom workflow" -description: "Create a custom workflow with a trigger, context repositories, and agent prompt." +description: "Create a custom Mintlify workflow with a schedule or push trigger, context repositories, and an agent prompt to automate recurring documentation tasks." keywords: ["automation", "automate", "cron", "agent"] --- diff --git a/workflows/enable.mdx b/workflows/enable.mdx index 379d4e7bc..6869cbbf7 100644 --- a/workflows/enable.mdx +++ b/workflows/enable.mdx @@ -1,6 +1,6 @@ --- title: "Enable workflows" -description: "Enable workflows on your project. Select triggers, add context repositories, and set schedules." +description: "Enable workflows on your Mintlify project. Configure GitHub or GitLab triggers, add context repositories, set schedules, and turn on automerge for the agent." keywords: ["cron", "push trigger", "automerge"] --- diff --git a/workflows/index.mdx b/workflows/index.mdx index fccf28cd1..da9fd38dd 100644 --- a/workflows/index.mdx +++ b/workflows/index.mdx @@ -1,6 +1,6 @@ --- title: "Overview" -description: "Automate tasks with the Mintlify agent on a schedule or in response to repository events." +description: "Automate documentation maintenance with Mintlify workflows. Run the agent on a schedule or in response to GitHub and GitLab repository pushes." keywords: ["automation", "automate", "cron", "agent"] --- diff --git a/workflows/manage.mdx b/workflows/manage.mdx index 59be92800..35be8fc61 100644 --- a/workflows/manage.mdx +++ b/workflows/manage.mdx @@ -1,6 +1,6 @@ --- title: "Manage workflows" -description: "Trigger, disable, enable, and delete Mintlify workflows from the dashboard." +description: "Trigger, disable, re-enable, and delete Mintlify workflows from your dashboard, and learn how schedules recalculate after a workflow is paused and resumed." keywords: ["manage workflows", "trigger workflow", "disable workflow", "enable workflow"] ---