From 1213dae2ad62c7f5450a1efb94360174c0170ab2 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 2 May 2026 02:38:38 +0000 Subject: [PATCH 1/2] Remove redundant description frontmatter from API reference pages Generated-By: mintlify-agent --- api/agent/create-agent-job.mdx | 1 - api/agent/get-agent-job.mdx | 1 - api/agent/get-all-jobs.mdx | 1 - api/agent/v2/create-agent-job.mdx | 1 - api/agent/v2/get-agent-job.mdx | 1 - api/agent/v2/send-message.mdx | 1 - api/analytics/assistant-caller-stats.mdx | 1 - api/analytics/assistant-conversations.mdx | 1 - api/analytics/feedback-by-page.mdx | 1 - api/analytics/feedback.mdx | 1 - api/analytics/searches.mdx | 1 - api/analytics/views.mdx | 1 - api/analytics/visitors.mdx | 1 - api/assistant/create-assistant-message-v2.mdx | 1 - api/assistant/create-assistant-message.mdx | 1 - api/assistant/get-page-content.mdx | 1 - api/assistant/search.mdx | 1 - api/preview/trigger.mdx | 1 - api/update/status.mdx | 1 - api/update/trigger.mdx | 1 - 20 files changed, 20 deletions(-) diff --git a/api/agent/create-agent-job.mdx b/api/agent/create-agent-job.mdx index ab24f3a37..094be290d 100644 --- a/api/agent/create-agent-job.mdx +++ b/api/agent/create-agent-job.mdx @@ -1,6 +1,5 @@ --- 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" diff --git a/api/agent/get-agent-job.mdx b/api/agent/get-agent-job.mdx index 1c6526e56..277af221e 100644 --- a/api/agent/get-agent-job.mdx +++ b/api/agent/get-agent-job.mdx @@ -1,6 +1,5 @@ --- 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" diff --git a/api/agent/get-all-jobs.mdx b/api/agent/get-all-jobs.mdx index 833bed5ec..d5357cfb7 100644 --- a/api/agent/get-all-jobs.mdx +++ b/api/agent/get-all-jobs.mdx @@ -1,6 +1,5 @@ --- 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" diff --git a/api/agent/v2/create-agent-job.mdx b/api/agent/v2/create-agent-job.mdx index 75e146e18..89e202a0f 100644 --- a/api/agent/v2/create-agent-job.mdx +++ b/api/agent/v2/create-agent-job.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/agent/v2/get-agent-job.mdx b/api/agent/v2/get-agent-job.mdx index f4db4ef63..893c13401 100644 --- a/api/agent/v2/get-agent-job.mdx +++ b/api/agent/v2/get-agent-job.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/agent/v2/send-message.mdx b/api/agent/v2/send-message.mdx index 5971d56f5..5a5e9f7f5 100644 --- a/api/agent/v2/send-message.mdx +++ b/api/agent/v2/send-message.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/analytics/assistant-caller-stats.mdx b/api/analytics/assistant-caller-stats.mdx index cd9527863..7ea1bff8d 100644 --- a/api/analytics/assistant-caller-stats.mdx +++ b/api/analytics/assistant-caller-stats.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/analytics/assistant-conversations.mdx b/api/analytics/assistant-conversations.mdx index 44b77777a..87e9ec375 100644 --- a/api/analytics/assistant-conversations.mdx +++ b/api/analytics/assistant-conversations.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/analytics/feedback-by-page.mdx b/api/analytics/feedback-by-page.mdx index 38cc6f620..7fed21249 100644 --- a/api/analytics/feedback-by-page.mdx +++ b/api/analytics/feedback-by-page.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/analytics/feedback.mdx b/api/analytics/feedback.mdx index ae028311a..8fb6ad654 100644 --- a/api/analytics/feedback.mdx +++ b/api/analytics/feedback.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/analytics/searches.mdx b/api/analytics/searches.mdx index 5cda5ca54..41b92550c 100644 --- a/api/analytics/searches.mdx +++ b/api/analytics/searches.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/analytics/views.mdx b/api/analytics/views.mdx index 599f5e949..c891a230a 100644 --- a/api/analytics/views.mdx +++ b/api/analytics/views.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/analytics/visitors.mdx b/api/analytics/visitors.mdx index b00949c0c..3cc8bb8f8 100644 --- a/api/analytics/visitors.mdx +++ b/api/analytics/visitors.mdx @@ -1,6 +1,5 @@ --- 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"] --- diff --git a/api/assistant/create-assistant-message-v2.mdx b/api/assistant/create-assistant-message-v2.mdx index 606d628b3..51d6ad6f1 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: [ diff --git a/api/assistant/create-assistant-message.mdx b/api/assistant/create-assistant-message.mdx index 977dd0242..1598001ad 100644 --- a/api/assistant/create-assistant-message.mdx +++ b/api/assistant/create-assistant-message.mdx @@ -1,6 +1,5 @@ --- 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" ] diff --git a/api/assistant/get-page-content.mdx b/api/assistant/get-page-content.mdx index b958465da..627327dd5 100644 --- a/api/assistant/get-page-content.mdx +++ b/api/assistant/get-page-content.mdx @@ -1,6 +1,5 @@ --- 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" ] --- diff --git a/api/assistant/search.mdx b/api/assistant/search.mdx index df9a1451d..cdffa881b 100644 --- a/api/assistant/search.mdx +++ b/api/assistant/search.mdx @@ -1,6 +1,5 @@ --- 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" ] --- diff --git a/api/preview/trigger.mdx b/api/preview/trigger.mdx index 47e526bd8..157757a1a 100644 --- a/api/preview/trigger.mdx +++ b/api/preview/trigger.mdx @@ -1,6 +1,5 @@ --- 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..9ceaa495b 100644 --- a/api/update/status.mdx +++ b/api/update/status.mdx @@ -1,6 +1,5 @@ --- 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..6f5600b15 100644 --- a/api/update/trigger.mdx +++ b/api/update/trigger.mdx @@ -1,6 +1,5 @@ --- 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" ] --- From de9b5a128ccc06f46a077d20e9dd3710ca6da333 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Sat, 2 May 2026 02:42:56 +0000 Subject: [PATCH 2/2] Improve too-short and too-long descriptions for better SEO Generated-By: mintlify-agent --- agent/index.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 +- 16 files changed, 16 insertions(+), 16 deletions(-) diff --git a/agent/index.mdx b/agent/index.mdx index 2ab9144b2..8fe57af95 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: "Use the Mintlify agent to draft, edit, and maintain documentation through pull requests triggered from Slack, GitHub PRs, the dashboard, or API calls." keywords: ["automation", "automate", "AI", "autoupdate", "maintenance"] --- diff --git a/components/cards.mdx b/components/cards.mdx index 9964ef71b..74733fe26 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: "Add card components in MDX to create clickable visual tiles with titles, icons, images, and links — useful for landing pages and quickstart layouts." keywords: ["cards", "visual containers"] --- diff --git a/editor-classic.mdx b/editor-classic.mdx index eb7178794..15abf07ad 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: "Use the classic Mintlify web editor to write, preview, and publish docs in your browser. Note: this editor is sunsetting on May 7, 2026." keywords: ["editor", "visual editor", "web editor"] tag: "Classic" --- diff --git a/editor/collaborate.mdx b/editor/collaborate.mdx index f6d8ad36b..ef44cdbd4 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: "Co-edit Mintlify docs in real time with teammates. See live cursors, share editor links, work on branches, and review preview deployments together." 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..41186e3a3 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 logos, colors, fonts, theme, and feature settings for your Mintlify docs site visually in the editor — no manual docs.json changes required." keywords: ["editor", "configurations", "settings", "branding", "theme"] --- diff --git a/editor/index.mdx b/editor/index.mdx index 1c367a9ba..f090c5ef1 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: "Write, edit, and publish Mintlify documentation in the browser. Includes real-time collaboration, automatic saving, live preview, and Git sync." keywords: ["editor", "visual", "collaborative", "web editor"] --- diff --git a/editor/live-preview.mdx b/editor/live-preview.mdx index d97bb0f28..696dd5e75 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: "Open a live preview alongside the Mintlify editor to see how pages render as you type, with responsive viewport options for desktop and mobile testing." keywords: ["editor", "preview", "live preview"] --- diff --git a/editor/navigation.mdx b/editor/navigation.mdx index b29b42009..5371e73e8 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, build groups and tabs, and manage your documentation sidebar with drag-and-drop in the Mintlify editor — without editing docs.json by hand." keywords: ["editor", "navigation", "sidebar", "structure"] --- diff --git a/editor/pages.mdx b/editor/pages.mdx index 5427829f5..28f91804e 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 new MDX pages, edit content in visual or markdown mode, upload images and video, and manage files inside the Mintlify web editor." 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..3e3c1d182 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 Mintlify preview deployment URLs and editor links so reviewers can see and feedback documentation changes on a branch before you publish them." keywords: ["editor", "preview", "preview deployment", "share", "collaboration", "feedback"] --- diff --git a/editor/tutorial.mdx b/editor/tutorial.mdx index 006728914..3c05ce9eb 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 tutorial for the Mintlify editor: create a branch, edit a page, share a preview 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..169089d2a 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: "Boost in-product search ranking for specific Mintlify pages or navigation groups by setting a numeric multiplier in page frontmatter or docs.json." keywords: ["search ranking", "search boost", "boost", "search prioritization"] --- diff --git a/workflows/create.mdx b/workflows/create.mdx index f8b994ee0..24623a9bf 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: "Build a custom Mintlify workflow by configuring a schedule or push trigger, attaching context repositories, and writing the prompt the agent runs." keywords: ["automation", "automate", "cron", "agent"] --- diff --git a/workflows/enable.mdx b/workflows/enable.mdx index 379d4e7bc..76664831f 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 Mintlify built-in workflows for your project: connect GitHub or GitLab, choose triggers, add context repositories, and set automerge or schedules." keywords: ["cron", "push trigger", "automerge"] --- diff --git a/workflows/index.mdx b/workflows/index.mdx index fccf28cd1..6d0793c07 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: "Run the Mintlify agent automatically with workflows. Schedule recurring jobs with cron or trigger runs on pushes and merges to GitHub or GitLab repos." keywords: ["automation", "automate", "cron", "agent"] --- diff --git a/workflows/manage.mdx b/workflows/manage.mdx index 59be92800..acd94430f 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: "Manage Mintlify workflows from the dashboard: manually trigger runs, disable or re-enable a workflow, view run history, and delete custom workflows." keywords: ["manage workflows", "trigger workflow", "disable workflow", "enable workflow"] ---