Automatisations prédéfinies

Référence des automatisations Mintlify prédéfinies : déclencheur par défaut, mode de mise à jour, prise en charge des dépôts et configurations requises.

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 de votre dashboard.

​

En un coup d’œil

Automatisation	Déclencheur par défaut	Mode de mise à jour par défaut	Dépôts de contexte	Configuration requise
Update from code changes	Calendrier personnalisé (deux fois par semaine)	Pull request	Pris en charge	Au moins un dépôt de code source
Draft changelog	Calendrier personnalisé	Pull request	Pris en charge	Aucune
Draft improvements from assistant conversations	Calendrier personnalisé	Pull request	Non pris en charge	Aucune
Draft improvements from user feedback	Calendrier personnalisé	Pull request	Non pris en charge	Collecte des retours activée
Translate content	Mise à jour de contenu	Fusion directe	Non pris en charge	Au moins une langue cible
Fix broken links	Mise à jour de contenu	Pull request	Non pris en charge	Aucune
Audit SEO metadata	Mise à jour de contenu	Pull request	Non pris en charge	Aucune
Fix grammar & typos	Mise à jour de contenu	Pull request	Non pris en charge	Aucune
Apply style guide	Mise à jour de contenu	Pull request	Non pris en charge	Aucune

Tous les paramètres par défaut peuvent être modifiés depuis le panneau de paramètres de l’automatisation. Consultez Configurations pour les options disponibles.

​

Automatisations de contenu auto-mis à jour

Les automatisations de contenu auto-mis à jour effectuent des mises à jour à partir d’un contexte que vous définissez afin que votre contenu reste précis et à jour.

​

Mettre à jour à partir des modifications de code

Surveille vos dépôts de code source et ouvre des pull requests pour mettre à jour le contenu en cas de modifications affectant les utilisateurs. Vous pouvez exécuter cette automatisation selon un calendrier, ce qui consomme généralement moins de crédits, ou à chaque pull request de code source. Par défaut, cette automatisation s’exécute deux fois par semaine (mardi et jeudi).

Lorsque vous exécutez l’automatisation selon un calendrier, l’agent lit toutes les pull requests de code source fusionnées depuis la dernière exécution. Il regroupe les modifications associées nécessitant des mises à jour de contenu dans une pull request sur le dépôt de votre projet Mintlify. S’il existe des pull requests non fusionnées provenant d’exécutions précédentes, l’agent ajoute les modifications pertinentes aux pull requests existantes. L’agent indique d’où proviennent les modifications dans vos dépôts de code source.

Lorsque vous exécutez l’automatisation à chaque pull request de code source, l’agent ouvre une pull request de mise à jour de contenu chaque fois que vous fusionnez un changement de code nécessitant des mises à jour de contenu. Utilisez la variante basée sur les pushes lorsque vous souhaitez que les mises à jour de contenu apparaissent dès que le code est livré, plutôt que groupées selon un calendrier.

Vous pouvez activer les intégrations de l’agent pour cette automatisation afin de fournir à l’agent un contexte supplémentaire provenant d’outils comme Slack ou Linear lors de la détermination des éléments à mettre à jour.

​

Brouillon de changelog

Crée une entrée de changelog selon un calendrier récurrent. Ajoutez des dépôts de code source comme contexte pour que l’agent dispose de plus de détails sur l’évolution de votre produit. Sans dépôts de contexte, l’agent se base sur vos mises à jour de contenu pour rédiger une entrée de changelog.

​

Brouillon d’améliorations à partir des conversations de l’assistant

Examine les tendances de questions issues de votre assistant pour identifier les lacunes de votre contenu, puis ouvre une pull request pour y remédier. Plus vos utilisateurs ont de conversations avec l’assistant, plus l’agent dispose de signaux à exploiter. Exécutez cette automatisation selon un calendrier récurrent pour maintenir votre contenu aligné avec ce que les utilisateurs souhaitent savoir sur votre produit.

​

Brouillon d’améliorations à partir des retours utilisateurs

Examine les retours sur les pages — évaluations par pouces et commentaires écrits — et met à jour le contenu là où les utilisateurs ont signalé des problèmes. L’agent se concentre sur les pages présentant des signaux négatifs récurrents plutôt que sur des retours ponctuels, de sorte que les résultats s’améliorent à mesure que les retours s’accumulent.

Vous devez activer la collecte des retours sur la page Add-ons avant de pouvoir utiliser cette automatisation.

​

Automatisations de maintenance

Les automatisations de maintenance automatisent les tâches routinières pour améliorer la qualité et la cohérence de votre contenu. Vous pouvez les exécuter sur un déclencheur de mise à jour de contenu ou selon un calendrier récurrent.

L’exécution sur un déclencheur de mise à jour de contenu maintient votre contenu avec un délai minimal. L’exécution selon un calendrier est généralement plus économe en crédits car l’agent regroupe le travail sur plusieurs modifications en une seule exécution. Le compromis est un délai entre le moment où le contenu change et le moment où l’automatisation agit dessus.

Chaque automatisation de maintenance conserve une seule pull request ouverte et y ajoute les nouveaux correctifs à mesure que le contenu évolue, de sorte que la maintenance courante s’accumule dans une seule pull request à relire au lieu de plusieurs.

Toute automatisation de maintenance activée s’exécute sur les pull requests créées par les automatisations de contenu auto-mis à jour. Si l’automatisation de maintenance identifie des modifications nécessaires, l’agent combine le travail dans une seule pull request. Par exemple, si vous activez l’automatisation Translate content, l’agent ajoute des traductions à toutes les pull requests ouvertes par l’automatisation Update from code changes.

​

Traduire le contenu

Traduit le contenu mis à jour dans les langues cibles que vous avez sélectionnées chaque fois que des modifications sont poussées vers le dépôt de votre projet. Vous devez spécifier au moins une langue cible. Mintlify lit les langues définies dans votre docs.json et présélectionne les langues cibles déjà configurées.

Pour désactiver les traductions pour une langue, supprimez tous les fichiers du répertoire de cette langue. Vous ne pouvez pas désactiver les traductions pour une langue qui contient encore du contenu publié.

​

Corriger les liens cassés

Trouve et corrige les liens internes et externes cassés chaque fois que des modifications de contenu sont poussées vers le dépôt de votre projet. Utile à exécuter après des réorganisations majeures de contenu ou lorsque les services externes que vous référencez modifient leurs URL.

​

Auditer les métadonnées SEO

Audite et met à jour les titres, méta descriptions, en-têtes et balises canoniques chaque fois que le contenu change. Ajoutez des instructions pour aligner les suggestions de l’agent avec votre stratégie SEO ou vos mots-clés cibles.

​

Corriger la grammaire et les fautes de frappe

Trouve et corrige les fautes de frappe, fautes d’orthographe et erreurs de grammaire chaque fois que le contenu change. Ajoutez des instructions pour préciser les exceptions concernant les termes techniques, les noms de produits ou les choix stylistiques intentionnels que l’agent ne doit pas modifier.

​

Appliquer le guide de style

Applique les règles de voix, de ton et d’écriture au contenu chaque fois qu’il change. Ajoutez des instructions pour définir les règles spécifiques que vous souhaitez appliquer ou pour lier votre guide de style. Plus vos instructions sont précises, plus les résultats sont cohérents.