Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-ac127224.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

L’éditeur expose deux groupes de paramètres :
  • Paramètres utilisateur ne s’appliquent qu’à vous et vous suivent sur tous les deployments.
  • Paramètres de publication s’appliquent à l’ensemble du deployment et concernent tous les éditeurs de l’équipe.

Paramètres utilisateur

Les paramètres utilisateur sont personnels. Les changements que vous effectuez n’affectent que votre éditeur et ne modifient rien pour vos collègues.

Préférences

Contrôlez l’apparence et le comportement de l’éditeur pour vous.
  • Structure de navigation : Comment la barre latérale gauche liste vos pages.
    • file-tree (par défaut) : Affiche les pages sous forme d’arborescence de fichiers reflétant votre dépôt.
    • docs-nav : Affiche les pages dans l’ordre défini par la navigation de votre docs.json.
  • Adapter à la largeur complète : Lorsque cette option est activée, le contenu s’étend sur toute la largeur de l’éditeur au lieu d’utiliser la largeur de lecture par défaut. Utile sur les écrans larges.
  • Ouvrir la prévisualisation dans un nouvel onglet : Lorsque cette option est activée, cliquer sur le bouton de prévisualisation en direct ouvre l’aperçu dans un nouvel onglet du navigateur plutôt que dans le panneau latéral.

Instructions d’IA

Ajoutez des instructions personnelles que les fonctionnalités d’IA de l’éditeur utiliseront pour générer ou modifier du contenu pour vous. Utilisez-les pour définir votre ton, votre vocabulaire ou vos règles de style préférés. Les instructions d’IA sont limitées à 20 000 caractères.
Gardez les instructions d’IA courtes et précises. Par exemple : “Utilisez la casse de phrase dans les titres. Évitez le mot ‘simplement’. Préférez la voix active.”

Paramètres de publication

Les paramètres de publication s’appliquent à l’ensemble de votre deployment. Toute personne autorisée à mettre à jour le deployment peut les modifier, et les valeurs sont utilisées pour chaque pull request créé depuis l’éditeur.
  • Instructions de commit : Consignes que l’éditeur suit lorsqu’il génère des messages de commit. Utilisez-les pour imposer un format de message de commit tel que Conventional Commits. Limité à 20 000 caractères.
  • Instructions de PR : Consignes que l’éditeur suit lorsqu’il génère les titres et descriptions de pull requests. Utilisez-les pour exiger un modèle de PR spécifique ou une liste de contrôle. Limité à 20 000 caractères.
  • Créer un PR en brouillon par défaut : Lorsque cette option est activée, l’éditeur ouvre les nouveaux pull requests en tant que brouillons. Activez cette option si votre équipe relit les changements en brouillon avant de demander une revue.
  • Méthode de fusion des PR : Comment l’éditeur fusionne les pull requests.
    • merge (par défaut) : Crée un commit de fusion.
    • squash : Combine tous les commits en un seul.
    • rebase : Rejoue les commits sur la branche cible sans commit de fusion.
La méthode de fusion des PR ne s’applique qu’aux fusions lancées depuis l’éditeur. Les fusions effectuées directement chez votre fournisseur Git utilisent la configuration de ce fournisseur.

Exemple : imposer Conventional Commits

Définissez des instructions de commit comme les suivantes pour que l’éditeur formate chaque message de commit de manière cohérente :
Instructions de commit
Utilisez le format Conventional Commits : <type>(<scope>) : <subject>.
Types : feat, fix, docs, chore, refactor.
Gardez le sujet sous 70 caractères et utilisez le mode impératif.