Skip to content
Closed
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
4 changes: 3 additions & 1 deletion automations/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: "Reference for all predefined Mintlify automations, including defau
keywords: ["predefined", "automation", "default"]
---

Mintlify includes predefined automations for the most common documentation maintenance tasks. Each automation has a base prompt and a default configuration. You can customize the trigger, update mode, and instructions from the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
Mintlify includes predefined automations for the most common documentation maintenance tasks. Each automation has a base prompt and a default configuration. You can customize the [trigger](/automations/manage#trigger), [update mode](/automations/manage#update-mode), and instructions from the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.

Each automation's default update mode is either **Pull request** (the agent opens a pull request for review) or **Direct merge** (the agent commits changes directly to your deploy branch). See [Update mode](/automations/manage#update-mode) for how to change this default.

## At a glance

Expand Down
4 changes: 3 additions & 1 deletion es/automations/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: "Referencia de las automatizaciones predefinidas de Mintlify: activ
keywords: ["predefinida", "automatización", "predeterminada"]
---

Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de documentación más comunes. Cada automatización tiene un prompt base y una configuración predeterminada. Puedes personalizar el activador, el modo de actualización y las instrucciones desde la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard.
Mintlify incluye automatizaciones predefinidas para las tareas de mantenimiento de documentación más comunes. Cada automatización tiene un prompt base y una configuración predeterminada. Puedes personalizar el [activador](/es/automations/manage#trigger), el [modo de actualización](/es/automations/manage#update-mode) y las instrucciones desde la página [Automatizaciones](https://app.mintlify.com/products/automations) en tu dashboard.

El modo de actualización predeterminado de cada automatización es **Pull request** (el agente abre una pull request para revisión) o **Fusión directa** (el agente confirma los cambios directamente en tu rama de despliegue). Consulta [Modo de actualización](/es/automations/manage#update-mode) para saber cómo cambiar este valor predeterminado.

<div id="at-a-glance">
## De un vistazo
Expand Down
6 changes: 6 additions & 0 deletions es/optimize/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,12 @@ Haz clic en un elemento de feedback para añadir una nota interna. Estas notas s

Usa las notas para añadir información para colaborar, vincular tickets relevantes de soporte o de ingeniería, o recordar cualquier otra información útil.

<div id="export-feedback">
## Exportar comentarios
</div>

Para descargar los comentarios y analizarlos o generar informes sin conexión, usa el botón **Export to CSV** en la página de [analytics](https://app.mintlify.com/analytics) y selecciona la categoría de comentarios. Consulta [Exportar analytics](/es/optimize/analytics#export-analytics) para ver el flujo completo. Para recuperar los comentarios de forma programática, usa el [endpoint de feedback de analytics](/es/api/analytics/feedback).

<div id="agent-feedback">
## Comentarios de agentes
</div>
Expand Down
12 changes: 12 additions & 0 deletions es/organize/related-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,15 @@ Para las implementaciones con [autenticación de usuario final](/es/deploy/authe
- [Páginas](/es/organize/pages): Configura los metadatos de la página con frontmatter.
- [Enlaces](/es/guides/linking): Mejores prácticas para conectar páginas entre sí.
- [Búsqueda](/es/optimize/search): Configura cómo se clasifican y filtran los resultados de búsqueda.

<div id="troubleshooting">
## Solución de problemas
</div>

Si la sección **Temas relacionados** no aparece en una página, comprueba lo siguiente:

- **Show related topics** está habilitado en la página [Add-ons](https://app.mintlify.com/settings/deployment/addons).
- El frontmatter de la página no establece `related: false`.
- En el modo **Manual**, la página tiene un campo `related` con al menos una entrada. Las páginas sin `related` no muestran ninguna sección en el modo Manual.
- La implementación no usa [autenticación de usuario final](/es/deploy/authentication-setup), que deshabilita las sugerencias automáticas.
- En el modo **Automático**, la página tiene un `title` para que el índice de búsqueda pueda hacer coincidencias.
4 changes: 3 additions & 1 deletion fr/automations/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: "Référence des automatisations Mintlify prédéfinies : déclench
keywords: ["predefined", "automation", "default"]
---

Mintlify inclut des automatisations prédéfinies pour les tâches de maintenance de documentation les plus courantes. Chaque automatisation possède un prompt de base et une configuration par défaut. Vous pouvez personnaliser le déclencheur, le mode de mise à jour et les instructions depuis la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard.
Mintlify inclut des automatisations prédéfinies pour les tâches de maintenance de documentation les plus courantes. Chaque automatisation possède un prompt de base et une configuration par défaut. Vous pouvez personnaliser le [déclencheur](/fr/automations/manage#trigger), le [mode de mise à jour](/fr/automations/manage#update-mode) et les instructions depuis la page [Automations](https://app.mintlify.com/products/automations) de votre dashboard.

Le mode de mise à jour par défaut de chaque automatisation est soit **Pull request** (l'agent ouvre une pull request pour examen), soit **Fusion directe** (l'agent applique directement les modifications sur votre branche de déploiement). Consultez [Mode de mise à jour](/fr/automations/manage#update-mode) pour savoir comment modifier cette valeur par défaut.

<div id="at-a-glance">
## En un coup d'œil
Expand Down
6 changes: 6 additions & 0 deletions fr/optimize/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ Cliquez sur un retour pour y ajouter une note interne. Ces notes sont uniquement

Utilisez les notes pour ajouter des informations afin de faciliter la collaboration, associer des tickets de support ou d’ingénierie pertinents, ou conserver toute autre information utile.

<div id="export-feedback">
## Exporter les retours
</div>

Pour télécharger les retours en vue d'une analyse hors ligne ou de rapports, utilisez le bouton **Export to CSV** sur la page [analytics](https://app.mintlify.com/analytics) et sélectionnez la catégorie feedback. Consultez [Exporter les analytics](/fr/optimize/analytics#export-analytics) pour la procédure complète. Pour récupérer les retours de manière programmatique, utilisez l'[endpoint de feedback analytics](/fr/api/analytics/feedback).

<div id="agent-feedback">
## Retours des agents
</div>
Expand Down
12 changes: 12 additions & 0 deletions fr/organize/related-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,15 @@ Pour les déploiements avec [authentification des utilisateurs finaux](/fr/deplo
- [Pages](/fr/organize/pages) : Configurez les métadonnées de page avec le frontmatter.
- [Création de liens](/fr/guides/linking) : Bonnes pratiques pour relier les pages entre elles.
- [Recherche](/fr/optimize/search) : Configurez la façon dont les résultats de recherche sont classés et filtrés.

<div id="troubleshooting">
## Dépannage
</div>

Si la section **Sujets associés** ne s'affiche pas sur une page, vérifiez les points suivants :

- **Show related topics** est activé sur la page [Modules complémentaires](https://app.mintlify.com/settings/deployment/addons).
- Le frontmatter de la page ne définit pas `related: false`.
- En mode **Manual**, la page comporte un champ `related` avec au moins une entrée. Les pages sans `related` n'affichent aucune section en mode Manual.
- Le déploiement n'utilise pas l'[authentification des utilisateurs finaux](/fr/deploy/authentication-setup), qui désactive les suggestions automatiques.
- En mode **Automatic**, la page dispose d'un `title` sur lequel l'index de recherche peut s'appuyer.
4 changes: 4 additions & 0 deletions optimize/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,10 @@ Click a piece of feedback to add an internal note. These notes are only visible

Use notes to add information for collaboration, link relevant support or engineering tickets, or remember any other useful information.

## Export feedback

To download feedback for offline analysis or reporting, use the **Export to CSV** button on the [analytics](https://app.mintlify.com/analytics) page and select the feedback category. See [Export analytics](/optimize/analytics#export-analytics) for the full flow. To retrieve feedback programmatically, use the [analytics feedback endpoint](/api/analytics/feedback).

## Agent feedback

<Note>
Expand Down
9 changes: 9 additions & 0 deletions organize/related-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

1. Navigate to the [Add-ons](https://app.mintlify.com/settings/deployment/addons) page in your dashboard.
2. In the "Related topics" section, enable **Show related topics**.
3. Choose a mode and, optionally, set a limit on how many pages are shown.

Check warning on line 13 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L13

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

## Modes

Expand All @@ -19,7 +19,7 @@
</ResponseField>

<ResponseField name="Manual" type="mode">
Only pages listed in a page's `related` frontmatter are shown. Pages without a `related` field display no **Related topics** section. Use this mode when you want full editorial control.

Check warning on line 22 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L22

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

### Limit
Expand Down Expand Up @@ -76,9 +76,18 @@
---
```

## How suggestions are generated

Check warning on line 79 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L79

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

In **Automatic** mode, related pages are generated from your docs' search index using the current page's title as the query. Results are filtered by the page's language and version when applicable, and the current page is excluded.

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

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

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

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

Check warning on line 81 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L81

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

For deployments with [end-user authentication](/deploy/authentication-setup), automatic suggestions are disabled to avoid leaking content across user contexts. Use the `related` frontmatter field to show curated suggestions on user-authenticated deployments.

Check warning on line 83 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L83

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

## Troubleshooting

If the **Related topics** section doesn't appear on a page, check the following:

- **Show related topics** is enabled on the [Add-ons](https://app.mintlify.com/settings/deployment/addons) page.

Check warning on line 89 in organize/related-pages.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/related-pages.mdx#L89

In general, use active voice instead of passive voice ('is enabled').
- The page's frontmatter does not set `related: false`.
- In **Manual** mode, the page has a `related` field with at least one entry. Pages without `related` show no section in Manual mode.
- The deployment does not use [end-user authentication](/deploy/authentication-setup), which disables automatic suggestions.
- In **Automatic** mode, the page has a `title` for the search index to match against.
4 changes: 3 additions & 1 deletion zh/automations/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ description: "所有预定义 Mintlify 自动化的参考,包括默认触发
keywords: ["predefined", "automation", "default"]
---

Mintlify 为最常见的文档维护任务提供了预定义自动化。每个自动化都有一个基础提示词和默认配置。你可以在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面自定义触发器、更新模式和指令。
Mintlify 为最常见的文档维护任务提供了预定义自动化。每个自动化都有一个基础提示词和默认配置。你可以在控制台的 [Automations](https://app.mintlify.com/products/automations) 页面自定义[触发器](/zh/automations/manage#trigger)、[更新模式](/zh/automations/manage#update-mode)和指令。

每个自动化的默认更新模式为 **Pull request**(agent 会打开一个 pull request 供你审核)或 **直接合并**(agent 直接将变更提交到你的部署分支)。有关如何更改此默认值,请参见[更新模式](/zh/automations/manage#update-mode)。

<div id="at-a-glance">
## 一览
Expand Down
6 changes: 6 additions & 0 deletions zh/optimize/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@ boost: 3

使用备注来补充协作所需的信息、关联相关的支持或工程工单,或记录任何其他有用的信息。

<div id="export-feedback">
## 导出反馈
</div>

如需下载反馈以进行离线分析或生成报告,请使用[分析](https://app.mintlify.com/analytics)页面上的 **Export to CSV** 按钮,并选择反馈类别。完整流程请参见[导出分析数据](/zh/optimize/analytics#export-analytics)。如需以编程方式获取反馈,请使用 [analytics 反馈端点](/zh/api/analytics/feedback)。

<div id="agent-feedback">
## Agent 反馈
</div>
Expand Down
12 changes: 12 additions & 0 deletions zh/organize/related-pages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,15 @@ related: false
- [页面](/zh/organize/pages):使用 frontmatter 配置页面元数据。
- [链接](/zh/guides/linking):连接页面的最佳实践。
- [搜索](/zh/optimize/search):配置搜索结果的排序和过滤方式。

<div id="troubleshooting">
## 故障排查
</div>

如果 **相关主题** 部分未在某个页面上显示,请检查以下事项:

- 在 [Add-ons](https://app.mintlify.com/settings/deployment/addons) 页面上已启用 **Show related topics**。
- 该页面的 frontmatter 未设置 `related: false`。
- 在 **Manual** 模式下,该页面的 `related` 字段至少包含一个条目。在 Manual 模式下,没有 `related` 字段的页面不会显示该部分。
- 该部署未使用[终端用户认证](/zh/deploy/authentication-setup),因为这会禁用自动推荐。
- 在 **Automatic** 模式下,该页面拥有可供搜索索引匹配的 `title`。