Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion agent/index.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down
2 changes: 1 addition & 1 deletion api/agent/create-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
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

Check warning on line 3 in api/agent/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/create-agent-job.mdx#L3

Use 'JSON' instead of 'json'.
keywords: [ "agent job", "create", "automation", "automate" ]
tag: "deprecated"

---

<Warning>This endpoint is deprecated. Use the [v2 create agent job](/api/agent/v2/create-agent-job) endpoint instead.</Warning>

This endpoint creates an agent job based on provided messages and branch information. The job executes asynchronously and returns a streaming response with the execution details and results.

If a branch doesn't exist, the agent creates one. If files are edited successfully, a pull request is automatically created at the end of the job.

Check warning on line 13 in api/agent/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/create-agent-job.mdx#L13

In general, use active voice instead of passive voice ('are edited').

## Rate limits

Expand Down
2 changes: 1 addition & 1 deletion api/agent/get-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -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}

Check warning on line 3 in api/agent/get-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/get-agent-job.mdx#L3

Use 'JSON' instead of 'json'.
keywords: [ "agent job", "status", "retrieve", "details" ]
tag: "deprecated"

---

<Warning>This endpoint is deprecated. Use the [v2 get agent job](/api/agent/v2/get-agent-job) endpoint instead.</Warning>
Expand Down
2 changes: 1 addition & 1 deletion api/agent/get-all-jobs.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/agent/get-all-jobs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/get-all-jobs.mdx#L3

Use 'JSON' instead of 'json'.
keywords: [ "agent jobs", "list", "monitoring" ]
tag: "deprecated"

---

<Warning>This endpoint is deprecated. Use the [v2 get agent job](/api/agent/v2/get-agent-job) endpoint instead.</Warning>
Expand Down
2 changes: 1 addition & 1 deletion api/agent/v2/create-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
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

Check warning on line 3 in api/agent/v2/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/create-agent-job.mdx#L3

Use 'JSON' instead of 'json'.
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.

Check warning on line 8 in api/agent/v2/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/create-agent-job.mdx#L8

Don't put a space before or after a dash.

If the agent edits files successfully, a pull request is automatically created and the `prLink` field is populated in the job response.

Check warning on line 10 in api/agent/v2/create-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/create-agent-job.mdx#L10

In general, use active voice instead of passive voice ('is populated').

## Rate limits

Expand Down
2 changes: 1 addition & 1 deletion api/agent/v2/get-agent-job.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
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}

Check warning on line 3 in api/agent/v2/get-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/get-agent-job.mdx#L3

Use 'JSON' instead of 'json'.
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`.

Once the agent creates a pull request, the `prLink` field is populated.

Check warning on line 10 in api/agent/v2/get-agent-job.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/get-agent-job.mdx#L10

In general, use active voice instead of passive voice ('is populated').
2 changes: 1 addition & 1 deletion api/agent/v2/send-message.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
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

Check warning on line 3 in api/agent/v2/send-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/send-message.mdx#L3

Use 'JSON' instead of 'json'.
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.

Check warning on line 8 in api/agent/v2/send-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/send-message.mdx#L8

In general, use active voice instead of passive voice ('is processed').

Check warning on line 8 in api/agent/v2/send-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/agent/v2/send-message.mdx#L8

Don't put a space before or after a dash.

## Rate limits

Expand Down
2 changes: 1 addition & 1 deletion api/analytics/assistant-caller-stats.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
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

Check warning on line 3 in api/analytics/assistant-caller-stats.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-caller-stats.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "assistant", "caller", "stats", "export"]

---

## Usage

Use this endpoint to see how assistant queries are distributed across different caller types. The response breaks down total queries into:

Check warning on line 10 in api/analytics/assistant-caller-stats.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-caller-stats.mdx#L10

In general, use active voice instead of passive voice ('are distributed').

- **web**: Queries from the documentation site
- **api**: Queries from direct API calls

Check warning on line 13 in api/analytics/assistant-caller-stats.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-caller-stats.mdx#L13

Use 'API' instead of 'api'.
- **other**: Queries from other sources (for example, integrations, SDKs)
- **total**: Sum of all query types

Expand Down
2 changes: 1 addition & 1 deletion api/analytics/assistant-conversations.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "assistant", "conversations", "export", "AI"]

---

## Usage
Expand All @@ -21,5 +21,5 @@
- **query**: The user's question
- **response**: The assistant's answer
- **sources**: Pages referenced in the response, with title and URL
- **resolutionStatus**: Whether the assistant successfully answered the question. Either `answered` or `unanswered`. Use this field to track and analyze documentation gaps surfaced by user questions the assistant could not resolve.

Check warning on line 24 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L24

Did you really mean 'resolutionStatus'?
- **queryCategory**: Classification of the query type (if available)

Check warning on line 25 in api/analytics/assistant-conversations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/assistant-conversations.mdx#L25

Did you really mean 'queryCategory'?
2 changes: 1 addition & 1 deletion api/analytics/feedback-by-page.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/analytics/feedback-by-page.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/feedback-by-page.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "feedback", "export", "by page", "aggregated"]

---

## Usage
Expand Down
2 changes: 1 addition & 1 deletion api/analytics/feedback.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/analytics/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/feedback.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "feedback", "export", "user feedback"]

---

## Usage
Expand Down
2 changes: 1 addition & 1 deletion api/analytics/searches.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/analytics/searches.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/searches.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "search", "export", "queries", "search terms"]

---

## Usage
Expand Down
2 changes: 1 addition & 1 deletion api/analytics/views.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/analytics/views.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/views.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "views", "page views", "traffic", "export"]

---

## Usage
Expand Down
2 changes: 1 addition & 1 deletion api/analytics/visitors.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/analytics/visitors.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/analytics/visitors.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["analytics", "visitors", "unique visitors", "traffic", "export"]

---

## Usage
Expand Down
2 changes: 1 addition & 1 deletion api/assistant/create-assistant-message-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
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

Check warning on line 3 in api/assistant/create-assistant-message-v2.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message-v2.mdx#L3

Use 'JSON' instead of 'json'.
keywords:
[
"assistant message",
Expand All @@ -12,6 +11,7 @@
"ai sdk v5",
"ai sdk v6",
]

---

<Info>
Expand Down
2 changes: 1 addition & 1 deletion api/assistant/create-assistant-message.mdx
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 3 in api/assistant/create-assistant-message.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/create-assistant-message.mdx#L3

Use 'JSON' instead of 'json'.
tag: "Deprecated"
keywords: [ "assistant message", "embed", "chat", "integrate", "ai sdk v4" ]

---
<Badge color="orange">Deprecated</Badge>

Expand Down
2 changes: 1 addition & 1 deletion api/assistant/get-page-content.mdx
Original file line number Diff line number Diff line change
@@ -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}"

Check warning on line 3 in api/assistant/get-page-content.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/get-page-content.mdx#L3

Use 'JSON' instead of 'json'.
keywords: [ "page", "content", "retrieve" ]

---

## Rate limits
Expand Down
2 changes: 1 addition & 1 deletion api/assistant/search.mdx
Original file line number Diff line number Diff line change
@@ -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}"

Check warning on line 3 in api/assistant/search.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/search.mdx#L3

Use 'JSON' instead of 'json'.
keywords: [ "search", "query" ]

---

## Rate limits
Expand Down
2 changes: 1 addition & 1 deletion api/preview/trigger.mdx
Original file line number Diff line number Diff line change
@@ -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}"

Check warning on line 3 in api/preview/trigger.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/preview/trigger.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["preview", "preview deployment", "branch preview", "staging"]

---

<Info>
Expand All @@ -15,7 +15,7 @@

## Use cases

- **CI/CD pipelines**: Automatically create preview deployments when pull requests are opened or updated.

Check warning on line 18 in api/preview/trigger.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/preview/trigger.mdx#L18

In general, use active voice instead of passive voice ('are opened').
- **Scheduled previews**: Build previews from long-running feature branches on a schedule.
- **Custom tooling**: Integrate preview creation into internal workflows or Slack bots.

Expand Down
2 changes: 1 addition & 1 deletion api/update/status.mdx
Original file line number Diff line number Diff line change
@@ -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" ]

---
2 changes: 1 addition & 1 deletion api/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -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" ]

---
2 changes: 1 addition & 1 deletion components/cards.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down
2 changes: 1 addition & 1 deletion editor-classic.mdx
Original file line number Diff line number Diff line change
@@ -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."

Check warning on line 3 in editor-classic.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor-classic.mdx#L3

Don't put a space before or after a dash.
keywords: ["editor", "visual editor", "web editor"]
tag: "Classic"
---
Expand Down
2 changes: 1 addition & 1 deletion editor/collaborate.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand All @@ -22,14 +22,14 @@

When multiple team members edit the same branch, changes sync in real-time. Page content, navigation structure, and site configuration updates appear automatically for all collaborators without refreshing.

- Each person's cursor and edits are visible to everyone on the page, with user avatars and names shown in the toolbar.

Check warning on line 25 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L25

Use 'Cursor' instead of 'cursor'.
- Changes merge automatically. Two people editing the same section won't cause conflicts.
- Undo only affects your own changes—undoing won't revert another person's edits.
- If you lose your network connection, your edits save locally and sync when you reconnect.

## See the agent's edits in real time

When the [Mintlify agent](/agent) edits a page through the API or MCP, it appears in the web editor like any other collaborator. If you have the page open on the same branch, you see the agent's avatar and name at the top of the editor and a live cursor at the location of its most recent edit.

Check warning on line 32 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L32

Use 'Cursor' instead of 'cursor'.

Use this to:

Expand All @@ -37,7 +37,7 @@
- See which paragraph or block the agent just updated without diffing the file.
- Coordinate with teammates and the agent on the same branch without overwriting each other's work.

The agent's cursor clears automatically a short time after the agent finishes editing.

Check warning on line 40 in editor/collaborate.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/collaborate.mdx#L40

Use 'Cursor' instead of 'cursor'.

## Branch-based collaboration

Expand Down
2 changes: 1 addition & 1 deletion editor/configurations.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down Expand Up @@ -74,7 +74,7 @@
- **Thumbnail background**: Set a custom background image for page thumbnails and social previews.
- **Thumbnail appearance**: Control how thumbnails display.
- **Thumbnail font**: Set a custom font for text in thumbnails.
- **Page eyebrow**: Add small labels above page titles.

Check warning on line 77 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L77

Use 'preceding' instead of 'above'.
- **Code block theme**: Choose the syntax highlighting theme for code blocks.
- **LaTeX support**: Enable mathematical notation rendering with LaTeX.
- **Icon library**: Choose the icon library to use for your site.
Expand All @@ -83,7 +83,7 @@

Customize the search experience.

- **Search placeholder**: The text that appears in the search box before users type. Default is "Search or ask...".

Check warning on line 86 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L86

Commas and periods go inside quotation marks.

Check warning on line 86 in editor/configurations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/configurations.mdx#L86

In general, don't use an ellipsis.

## Connect integrations

Expand Down
2 changes: 1 addition & 1 deletion editor/index.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down
2 changes: 1 addition & 1 deletion editor/live-preview.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down
2 changes: 1 addition & 1 deletion editor/navigation.mdx
Original file line number Diff line number Diff line change
@@ -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."

Check warning on line 3 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L3

Don't put a space before or after a dash.

Check warning on line 3 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["editor", "navigation", "sidebar", "structure"]
---

Expand All @@ -10,7 +10,7 @@

Click **Add new** at the bottom of the navigation tree to add a new element at the root level. To add an element nested inside another, click the <Icon icon="plus" /> plus button next to that element.

After creating an element, drag and drop it to reorder or nest it. Hover over an element and click the gear icon to configure its properties.

Check warning on line 13 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L13

Use the Oxford comma in 'After creating an element, drag and'.

Right-click a **page** to open its settings or delete it.

Expand All @@ -24,15 +24,15 @@

Choose the right structure for your content:

- **Pages** — Individual documentation files. The core building block of navigation.

Check warning on line 27 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L27

Don't put a space before or after a dash.
- **Groups** — Collapsible sections that cluster related pages together. Can nest within other groups.

Check warning on line 28 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L28

Don't put a space before or after a dash.
- **Tabs** — Top-level sections with horizontal navigation at the top of your site. Use tabs when you have distinct areas like API Reference and Guides.

Check warning on line 29 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L29

Don't put a space before or after a dash.
- **Anchors** — Persistent items at the top of your sidebar. Useful for quick access to external resources or top-level sections. Can be global to appear on every page.

Check warning on line 30 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L30

Don't put a space before or after a dash.
- **Dropdowns** — Expandable menus at the top of your sidebar. A lighter alternative to tabs for multiple related sections.

Check warning on line 31 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L31

Use 'dropdowns?' instead of 'Dropdowns'.

Check warning on line 31 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L31

Don't put a space before or after a dash.
- **Menus** — Dropdown navigation items within a tab for direct links to specific pages.

Check warning on line 32 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L32

Don't put a space before or after a dash.

Check warning on line 32 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L32

Use 'dropdowns?' instead of 'Dropdown'.
- **Products** — A switcher for multiple distinct product documentation sets, each with its own navigation structure.

Check warning on line 33 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L33

Don't put a space before or after a dash.
- **Versions** — A switcher for multiple simultaneous documentation versions.

Check warning on line 34 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L34

Don't put a space before or after a dash.
- **Languages** — A switcher for documentation in multiple languages.

Check warning on line 35 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L35

Don't put a space before or after a dash.

## Configure elements

Expand All @@ -40,5 +40,5 @@

- **Title**: The label shown in the sidebar.
- **Icon**: A visual marker next to the label.
- **Tag**: A badge like "NEW" or "BETA" to highlight the item.

Check warning on line 43 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L43

Spell out 'NEW', if it's unfamiliar to the audience.

Check warning on line 43 in editor/navigation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/navigation.mdx#L43

Spell out 'BETA', if it's unfamiliar to the audience.

2 changes: 1 addition & 1 deletion editor/pages.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand All @@ -9,7 +9,7 @@
Browse pages in the **Navigation** tab of the left panel. Click a page to open it. Click the search icon or press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows) to search by filename or page content.

<Note>
API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. To update a spec file, edit it in your preferred code editor and push the changes to your documentation repository.

Check warning on line 12 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L12

In general, use active voice instead of passive voice ('are read').
</Note>

## Create new pages
Expand All @@ -31,12 +31,12 @@

- **Insert a link**: Select text and press <kbd>Cmd</kbd> + <kbd>K</kbd> (macOS) or <kbd>Ctrl</kbd> + <kbd>K</kbd> (Windows), or drag a page from the navigation tree into the editor to create a link with the page title.
- **Insert an emoji**: Type <kbd>:</kbd> followed by a keyword to open the emoji picker.
- **Edit a table**: When your cursor is inside a table, use the floating toolbar to add or remove rows and columns, or merge cells.

Check warning on line 34 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L34

Use 'Cursor' instead of 'cursor'.

**Markdown mode** gives you direct access to the MDX source. Use it for precise control over component properties and frontmatter.

<Note>
API specification files (OpenAPI and AsyncAPI) are read-only in the web editor. Edit them in your code editor and push the changes to your repository.

Check warning on line 39 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L39

In general, use active voice instead of passive voice ('are read').
</Note>

For a full list of components, see [Components](/components). For MDX syntax, see [Format text](/create/text) and [Format code](/create/code).
Expand All @@ -56,7 +56,7 @@

### Table of contents

In visual mode, the editor shows a minimap on the right side of the page that reflects the heading structure of your document. Hover over the minimap to expand it into a full table of contents. Click any heading to scroll to that section.

Check warning on line 59 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L59

Did you really mean 'minimap'?

Check warning on line 59 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L59

Did you really mean 'minimap'?

### Code block options

Expand All @@ -69,26 +69,26 @@

## Review changes before publishing

Open the publish menu and click any changed file to enter diff view. The editor highlights differences between your draft and the last published version. If you're in visual mode, you see a visual diff; if you're in Markdown mode, you see a Markdown diff.

Check warning on line 72 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L72

Use semicolons judiciously.

Diff view is read-only. Click the <Icon icon="x" /> button next to the mode toggle to return to editing.

Check warning on line 74 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L74

Use 'diffs?' instead of 'Diff'.

Check warning on line 74 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L74

In general, use active voice instead of passive voice ('is read').

## Manage pages

- **Move**: Drag and drop pages to reorder them in navigation.
- **Rename**: Right-click a page and select **Rename**.
- **Duplicate**: Right-click a page and select **Duplicate**.
- **Delete**: Right-click a page and select **Delete**. The page is removed from navigation automatically.

Check warning on line 81 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L81

In general, use active voice instead of passive voice ('is removed').

### Pages deleted via Git

If a teammate deletes a page through Git while you have it open, the editor enters read-only mode and shows a banner. Your content is preserved so you can copy it before navigating away.

Check warning on line 85 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L85

In general, use active voice instead of passive voice ('is preserved').

## Configure pages

Hover over a page and click the gear icon, or right-click and select **Settings**, to configure:

- **Title**, **Slug**, and **Sidebar title**: Control how the page appears in navigation and its URL.

Check warning on line 91 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L91

Use 'sidebars?' instead of 'Sidebar'.
- **Description** and **Keywords**: Improve search and SEO.
- **Layout**: Choose from standard, wide, centered, or custom.

Expand All @@ -100,7 +100,7 @@

Type <kbd>/image</kbd> to upload a new image or select an existing one from your repository. Type <kbd>/video</kbd> to upload or select a video.

You can also drag and drop files from your computer directly onto a page. In visual mode, the file inserts inline. In Markdown mode, the editor inserts the file path at your cursor position. Images save to your `images/` folder and videos to `videos/`.

Check warning on line 103 in editor/pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/pages.mdx#L103

Use 'Cursor' instead of 'cursor'.

### Light and dark image variants

Expand Down
2 changes: 1 addition & 1 deletion editor/share-a-preview.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
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"]
---

## Preview deployments

Every time you save changes to a feature branch, Mintlify builds a preview deployment — a temporary URL where your changes are rendered exactly as they'll look when published. Use it to review your work or collect feedback before merging.

Check warning on line 9 in editor/share-a-preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/share-a-preview.mdx#L9

Don't put a space before or after a dash.

Check warning on line 9 in editor/share-a-preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/share-a-preview.mdx#L9

In general, use active voice instead of passive voice ('are rendered').

### Access your preview

Expand All @@ -15,7 +15,7 @@

### Share your preview

Copy the preview URL and send it to reviewers. The preview updates automatically each time you save to the branch — no need to reshare.

Check warning on line 18 in editor/share-a-preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/share-a-preview.mdx#L18

Don't put a space before or after a dash.

Check warning on line 18 in editor/share-a-preview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/share-a-preview.mdx#L18

Did you really mean 'reshare'?

### Restrict access to previews

Expand Down
2 changes: 1 addition & 1 deletion editor/tutorial.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down Expand Up @@ -39,7 +39,7 @@

</Step>
<Step title="Publish your branch">
To review your changes, you must create a pull request. A pull request is a proposal to merge your changes into the main branch that your site is built from.

Check warning on line 42 in editor/tutorial.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/tutorial.mdx#L42

In general, use active voice instead of passive voice ('is built').

When you publish your branch, you make it available for review by your team. The changes only appear on your live site if you merge the pull request.

Expand All @@ -58,6 +58,6 @@
Share your pull request with your team to review your changes.
</Step>
<Step title="Merge your pull request">
When your changes are approved, merge your pull request into the main branch. Your changes deploy to your live site.

Check warning on line 61 in editor/tutorial.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

editor/tutorial.mdx#L61

In general, use active voice instead of passive voice ('are approved').
</Step>
</Steps>
2 changes: 1 addition & 1 deletion optimize/search-boost.mdx
Original file line number Diff line number Diff line change
@@ -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."

Check warning on line 3 in optimize/search-boost.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/search-boost.mdx#L3

Use 'JSON' instead of 'json'.
keywords: ["search ranking", "search boost", "boost", "search prioritization"]
---

Expand Down
2 changes: 1 addition & 1 deletion workflows/create.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down
2 changes: 1 addition & 1 deletion workflows/enable.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand Down
2 changes: 1 addition & 1 deletion workflows/index.mdx
Original file line number Diff line number Diff line change
@@ -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"]
---

Expand All @@ -22,8 +22,8 @@

Workflows support two trigger types.

- **Schedule (cron)** — Run on a recurring daily, weekly, or monthly schedule. Workflows queue within 10 minutes of the scheduled time.

Check warning on line 25 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L25

Don't put a space before or after a dash.
- **Push events** — Run when changes push to a specific repository or branch, including pull request merges and direct pushes.

Check warning on line 26 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L26

Don't put a space before or after a dash.

You cannot combine trigger types in a single workflow. Each workflow has exactly one trigger.

Expand Down
2 changes: 1 addition & 1 deletion workflows/manage.mdx
Original file line number Diff line number Diff line change
@@ -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."

Check warning on line 3 in workflows/manage.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/manage.mdx#L3

In general, use active voice instead of passive voice ('is paused').
keywords: ["manage workflows", "trigger workflow", "disable workflow", "enable workflow"]
---

Expand Down
Loading