Skip to content
Open
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: 4 additions & 0 deletions assistant/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
---

<Info>
The assistant is included on [Pro and Enterprise plans](https://mintlify.com/pricing?ref=assistant) and enabled by default for those plans. Hobby plan users can [purchase a credit package](/assistant/configure#manage-billing) to add the assistant to their site.

Check warning on line 9 in assistant/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

assistant/index.mdx#L9

In general, use active voice instead of passive voice ('is included').
</Info>

## About the assistant
Expand Down Expand Up @@ -40,6 +40,10 @@

The [assistant page](https://dashboard.mintlify.com/products/assistant) shows usage trends for the month to date. View more detailed insights on the [analytics](/optimize/analytics#assistant) page.

<Tip>
Enable the [Improve docs from assistant chats](/workflows/enable#improve-docs-from-assistant-chats) workflow to have the agent review question trends on a schedule and open targeted documentation updates.
</Tip>

## Make content AI ingestible

Structure your documentation to help the assistant provide accurate, relevant answers. Clear organization and comprehensive context benefit both human readers and AI understanding.
Expand Down
29 changes: 29 additions & 0 deletions es/agent/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,35 @@ Al crear o editar un flujo de trabajo en el dashboard, habilita las notificacion
3. Busca y selecciona los canales a los que deseas notificar.
4. Guarda tu flujo de trabajo.

<div id="improve-docs-from-assistant-chats">
## Mejorar la documentación a partir de los chats del assistant
</div>

El flujo de trabajo **Improve docs from assistant chats** revisa las conversaciones recientes del [assistant](/es/assistant/index) según una programación periódica, identifica tendencias en las preguntas de los usuarios y abre solicitudes de extracción específicas para cubrir vacíos o aclarar el contenido sobre el que los usuarios preguntan con frecuencia.

Usa este flujo de trabajo para:

- Detectar vacíos en la documentación a partir de preguntas reales de los usuarios en lugar de adivinar qué mejorar.
- Mantener claros y fáciles de encontrar los temas más consultados a medida que tu producto evoluciona.
- Reducir las preguntas repetidas abordando la causa de la confusión en tu documentación.

<div id="configure-the-workflow">
### Configurar el flujo de trabajo
</div>

Este flujo de trabajo se ejecuta según una programación y no utiliza repositorios de disparador ni de contexto. El agente lee de tu documentación publicada y del historial reciente de chats del assistant.

1. Abre la página [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) en tu dashboard.
2. Haz clic en el interruptor junto a **Improve docs from assistant chats**.
3. En el modal de configuración, define una programación acorde con la frecuencia con la que quieres que el agente revise los chats. Una cadencia semanal funciona bien para la mayoría de los proyectos.
4. Opcionalmente, agrega instrucciones para enfocar al agente en un área de producto, audiencia o estilo específicos.
5. Elige si el flujo de trabajo abre una solicitud de extracción para revisión o actualiza el contenido automáticamente. Se recomienda mantener la revisión.
6. Haz clic en **Turn on workflow**.

<Tip>
La calidad de las actualizaciones sugeridas depende del volumen de tráfico del assistant. Habilita este flujo de trabajo después de que el assistant haya estado activo el tiempo suficiente para recopilar una muestra representativa de preguntas.
</Tip>

<div id="manage-workflows">
## Gestionar flujos de trabajo
</div>
Expand Down
4 changes: 4 additions & 0 deletions es/assistant/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ Usa la información del assistant para entender cómo los usuarios interactúan

La [página del assistant](https://dashboard.mintlify.com/products/assistant) muestra las tendencias de uso del mes actual. Consulta información más detallada en la página de [analíticas](/es/optimize/analytics#assistant).

<Tip>
Habilita el flujo de trabajo [Mejorar la documentación a partir de los chats del assistant](/es/agent/workflows#improve-docs-from-assistant-chats) para que el agente revise las tendencias de preguntas según una programación y abra actualizaciones específicas en la documentación.
</Tip>

<div id="make-content-ai-ingestible">
## Haz que el contenido sea procesable por IA
</div>
Expand Down
29 changes: 29 additions & 0 deletions fr/agent/workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,35 @@ Lors de la création ou de la modification d'un workflow dans le dashboard, acti
3. Recherchez et sélectionnez les canaux que vous souhaitez notifier.
4. Enregistrez votre workflow.

<div id="improve-docs-from-assistant-chats">
## Améliorer la documentation à partir des chats de l'assistant
</div>

Le workflow **Improve docs from assistant chats** examine les conversations récentes de l'[assistant](/fr/assistant/index) selon une planification récurrente, identifie les tendances dans les questions des utilisateurs et ouvre des pull requests ciblées pour combler les lacunes ou clarifier le contenu sur lequel les utilisateurs posent fréquemment des questions.

Utilisez ce workflow pour :

- Faire ressortir les lacunes de la documentation à partir des questions réelles des utilisateurs au lieu de deviner ce qu'il faut améliorer.
- Garder clairs et faciles à trouver les sujets les plus consultés à mesure que votre produit évolue.
- Réduire les questions répétitives en traitant la source de la confusion dans votre documentation.

<div id="configure-the-workflow">
### Configurer le workflow
</div>

Ce workflow s'exécute selon une planification et n'utilise pas de référentiels de déclencheur ni de contexte. L'agent lit votre documentation publiée ainsi que l'historique récent des chats de l'assistant.

1. Ouvrez la page [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) dans votre dashboard.
2. Cliquez sur le commutateur à côté de **Improve docs from assistant chats**.
3. Dans la fenêtre des paramètres, définissez une planification correspondant à la fréquence à laquelle vous souhaitez que l'agent examine les chats. Une cadence hebdomadaire convient à la plupart des projets.
4. Ajoutez éventuellement des instructions pour orienter l'agent vers un domaine produit, un public ou un style spécifiques.
5. Choisissez si le workflow ouvre une pull request pour révision ou met à jour le contenu automatiquement. La révision est recommandée.
6. Cliquez sur **Turn on workflow**.

<Tip>
La qualité des mises à jour suggérées dépend du volume de trafic de l'assistant. Activez ce workflow lorsque l'assistant a été en service suffisamment longtemps pour recueillir un échantillon représentatif de questions.
</Tip>

<div id="manage-workflows">
## Gérer les workflows
</div>
Expand Down
4 changes: 4 additions & 0 deletions fr/assistant/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,10 @@ Utilisez les statistiques de l'assistant pour comprendre comment les utilisateur

La [page de l'assistant](https://dashboard.mintlify.com/products/assistant) affiche les tendances d'utilisation du mois en cours. Consultez des statistiques plus détaillées sur la page [analytiques](/fr/optimize/analytics#assistant).

<Tip>
Activez le workflow [Améliorer la documentation à partir des chats de l'assistant](/fr/agent/workflows#improve-docs-from-assistant-chats) pour que l'agent examine les tendances des questions selon une planification et ouvre des mises à jour ciblées de la documentation.
</Tip>

<div id="make-content-ai-ingestible">
## Rendre le contenu exploitable par l'IA
</div>
Expand Down
25 changes: 25 additions & 0 deletions workflows/enable.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,31 @@

#### Run a translation immediately

After saving the workflow, click **Translate now** to run it on demand using the currently saved target languages. The workflow must be enabled to trigger a manual run. Manual runs do not affect the workflow's regular trigger.

Check warning on line 75 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L75

In general, use active voice instead of passive voice ('be enabled').

## Improve docs from assistant chats

The **Improve docs from assistant chats** workflow reviews recent [assistant](/assistant/index) conversations on a recurring schedule, identifies trends in user questions, and opens targeted pull requests to fill gaps or clarify content that users frequently ask about.

Use this workflow to:

- Surface documentation gaps from real user questions instead of guessing what to improve.
- Keep frequently asked topics clear and discoverable as your product changes.
- Reduce repeat questions by addressing the source of confusion in your docs.

### Configure the workflow

This workflow runs on a schedule and does not use trigger or context repositories. The agent reads from your published documentation and recent assistant chat history.

1. Open the [Workflows](https://dashboard.mintlify.com/products/workflows?tab=workflows) page in your dashboard.
2. Click the toggle beside **Improve docs from assistant chats**.
3. In the settings modal, set a schedule that matches how often you want the agent to review chats. A weekly cadence works well for most projects.
4. Optionally add instructions to focus the agent on a specific product area, audience, or style.
5. Choose whether the workflow opens a pull request for review or updates content automatically. Reviews are recommended.

Check warning on line 95 in workflows/enable.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/enable.mdx#L95

In general, use active voice instead of passive voice ('are recommended').
6. Click **Turn on workflow**.

<Tip>
The quality of suggested updates depends on the volume of assistant traffic. Enable this workflow after the assistant has been live long enough to collect a representative sample of questions.
</Tip>

<GitlabWorkflowSetup />
2 changes: 1 addition & 1 deletion workflows/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
When a workflow runs, the agent clones any specified repositories as context and follows the prompt.

<Tip>
Use workflows that run on a schedule to automate recurring tasks, like publishing changelogs or checking for grammar and style issues.
Use workflows that run on a schedule to automate recurring tasks, like publishing changelogs, checking for grammar and style issues, or [improving docs from assistant chat trends](/workflows/enable#improve-docs-from-assistant-chats).

Use workflows that run on push events to automate reactive maintenance tasks, like updating API reference documentation or identifying documentation updates needed for new features.
</Tip>
Expand All @@ -20,8 +20,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 23 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L23

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 24 in workflows/index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

workflows/index.mdx#L24

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
Loading