Workflows prédéfinis

Référence pour tous les workflows Mintlify prédéfinis, incluant le trigger par défaut, le mode de mise à jour, la prise en charge des dépôts de contexte et les configurations requises.

Mintlify inclut des workflows prédéfinis pour les tâches de maintenance de documentation les plus courantes. Chaque workflow possède un prompt de base et une configuration par défaut. Vous pouvez personnaliser le trigger, le mode de mise à jour et les instructions depuis la page Workflows de votre tableau de bord.

Workflows de contenu auto-mis à jour

Les workflows de contenu auto-mis à jour effectuent des mises à jour en fonction du contexte que vous définissez afin que votre contenu reste exact et à jour.

Mettre à jour à partir des changements de code

Surveille vos dépôts de code source et ouvre des pull requests pour mettre à jour le contenu lors de changements qui affectent les utilisateurs. Vous pouvez exécuter ce workflow selon une planification, ce qui consomme généralement moins de crédits, ou à chaque pull request de code source. Par défaut, le workflow s’exécute selon une planification hebdomadaire.

Lorsque vous exécutez le workflow selon une planification, l’agent lit toutes les pull requests de code source fusionnées depuis la dernière exécution du workflow. Il regroupe les changements connexes qui nécessitent des mises à jour de contenu dans une pull request dans votre dépôt de projet Mintlify. S’il existe des pull requests non fusionnées issues d’exécutions précédentes, l’agent ajoute les changements pertinents aux pull requests existantes. L’agent cite l’origine des changements dans vos dépôts de code source.

Lorsque vous exécutez le workflow à chaque pull request de code source, l’agent crée une pull request de mise à jour de contenu chaque fois que vous fusionnez une pull request de code source qui nécessite 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 regroupées selon une planification.

Vous pouvez activer les intégrations de l’agent pour ce workflow afin de donner à l’agent un contexte supplémentaire depuis des outils comme Slack ou Linear lors de la détermination de ce qu’il faut mettre à jour.

Rédiger un changelog

Crée une entrée de changelog selon une planification récurrente. 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 travaille à partir de vos mises à jour de contenu pour rédiger une entrée de changelog.

Rédiger des améliorations à partir des conversations de l’assistant

Analyse les tendances des questions de votre assistant pour identifier les lacunes dans votre contenu, puis ouvre une pull request pour les combler. Plus vos utilisateurs ont de conversations avec l’assistant, plus l’agent dispose de signal pour travailler. Exécutez ce workflow selon une planification récurrente pour maintenir le contenu aligné sur ce que les utilisateurs veulent savoir sur votre produit.

Rédiger des améliorations à partir des retours des utilisateurs

Analyse les retours sur les pages — évaluations pouce haut/bas 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 isolés, de sorte que les résultats s’améliorent à mesure que les retours s’accumulent.

Vous devez activer la collecte de retours sur la page Modules complémentaires avant de pouvoir utiliser ce workflow.

Workflows de maintenance

Les workflows 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 avec un trigger de mise à jour de contenu ou selon une planification récurrente.

L’exécution avec un trigger de mise à jour de contenu maintient votre contenu avec un délai minimal. L’exécution selon une planification est généralement plus économe en crédits, car l’agent regroupe le travail à travers plusieurs changements dans une seule exécution, mais il y a un délai entre le moment où le contenu change et le moment où le workflow de maintenance agit dessus.

Tous les workflows de maintenance activés s’exécutent sur les pull requests créées par les workflows de contenu auto-mis à jour. Si le workflow de maintenance nécessite des changements, l’agent combine le travail dans une seule pull request. Par exemple, si vous activez le workflow traduire le contenu, l’agent ajoute des traductions aux pull requests ouvertes par le workflow mettre à jour à partir des changements de code.

Traduire le contenu

Traduit le contenu mis à jour dans les langues cibles que vous sélectionnez chaque fois que des changements sont poussés vers votre dépôt de 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 rompus

Trouve et corrige les liens internes et externes rompus chaque fois que des changements de contenu sont poussés vers votre dépôt de projet. Utile à exécuter après des réorganisations majeures de contenu ou lorsque les services externes auxquels vous faites référence changent leurs URLs.

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, les fautes d’orthographe et les erreurs grammaticales chaque fois que le contenu change. Ajoutez des instructions pour spécifier des exceptions concernant les termes techniques, les noms de produits ou les choix stylistiques intentionnels que l’agent ne doit pas modifier.

Appliquer la charte 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 faire respecter ou liez votre charte de style. Plus vos instructions sont précises, plus les résultats sont cohérents.