Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://mintlify-docs-editor-ui-appearance-settings.mintlify.app/llms.txt

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

L’éditeur web comporte deux niveaux de paramètres :
  • Vos paramètres ne s’appliquent qu’à vous. Ils contrôlent la mise en page de l’éditeur et la façon dont l’IA de l’éditeur vous assiste pendant vos modifications.
  • Les paramètres de publication s’appliquent à toutes les personnes d’un déploiement et déterminent ce qui se passe lorsque les modifications sont committées puis transformées en pull requests.
Vous pouvez configurer les deux depuis le menu Settings de l’éditeur.

​
Interface et apparence

Les paramètres d’interface et d’apparence sont liés à votre compte utilisateur. Les modifications s’appliquent à tous les déploiements que vous ouvrez dans l’éditeur et se synchronisent sur vos autres appareils. Ouvrez Settings dans l’éditeur et sélectionnez UI & Appearance pour mettre à jour ces préférences. Choisissez la vue par défaut du panneau de navigation gauche :
  • Docs navigation : Affiche les pages regroupées de la même manière qu’elles apparaissent sur votre site publié, selon la structure définie dans docs.json. Idéal lorsque vous pensez à votre documentation en fonction de l’endroit où les lecteurs trouvent chaque page.
  • File tree : Affiche le système de fichiers du dépôt, y compris les ressources, les snippets et les fichiers qui ne font pas partie de docs.json. Idéal pour les tâches au niveau du dépôt, comme renommer des fichiers ou travailler avec des images.
Vous pouvez à tout moment basculer entre les vues depuis la barre latérale — ce paramètre ne contrôle que la vue ouverte par défaut.

​
Ajuster l’éditeur en pleine largeur

Activez cette option pour que la zone d’édition s’étende sur tout l’espace horizontal disponible, au lieu de conserver la colonne de largeur de lecture par défaut. Utilisez la pleine largeur lorsque vous travaillez avec de grands tableaux, de longs blocs de code ou des composants côte à côte. Laissez-la désactivée pour correspondre à la longueur de ligne que voient les lecteurs sur votre site publié.

​
Ouvrir l’aperçu en direct dans un nouvel onglet

Par défaut, l’aperçu en direct s’ouvre en superposition dans le tableau de bord. Activez cette option pour ouvrir l’aperçu dans un nouvel onglet du navigateur. Un onglet séparé est utile lorsque vous voulez :
  • Garder l’aperçu visible sur un second écran pendant que vous éditez.
  • Redimensionner la fenêtre d’aperçu indépendamment du tableau de bord.
  • Recharger ou partager l’URL de l’aperçu sans quitter l’éditeur.

​
Instructions d’IA

Les instructions d’IA sont des consignes persistantes que l’éditeur envoie à l’IA avec votre requête. Utilisez-les pour fixer des règles de style et de ton que vous ne voulez pas répéter à chaque fois, comme la voix, la terminologie ou les conventions de mise en forme. Vos instructions s’appliquent à :
  • Les actions Edit with AI sur une sélection, comme réécrire, développer ou corriger.
  • Les sessions de l’agent lancées depuis l’éditeur.
Les instructions sont liées à votre compte utilisateur, donc chaque membre de l’équipe gère les siennes.

​
Quand utiliser les instructions d’IA

Ajoutez des instructions d’IA lorsque vous vous surprenez à répéter les mêmes consignes dans vos prompts, par exemple :
  • Imposer la deuxième personne ou des titres en majuscule initiale uniquement.
  • Privilégier des noms de produit ou une terminologie spécifiques.
  • Bannir le langage marketing ou les phrases de remplissage.
  • Exiger certains composants, comme toujours utiliser <Note> pour les encarts.
Gardez les instructions courtes et précises. L’IA les suit à chaque requête, donc des règles vagues ou contradictoires dégradent les résultats.

​
Configurer les instructions d’IA

  1. Ouvrez l’éditeur et cliquez sur votre avatar dans la barre d’outils.
  2. Sélectionnez Settings.
  3. Dans le champ AI instructions, saisissez les consignes que l’IA doit suivre.
  4. Enregistrez vos modifications.
Exemple : 
- Use second person ("you") and active voice.
- Use sentence case for all headings.
- Refer to the product as "Acme" — never "Acme Inc." or "the platform".
- Wrap notes and warnings in <Note> or <Warning> components.
- Do not add introductory filler like "In this guide" or "Let's explore".
Laissez le champ vide pour supprimer vos instructions.

​
Paramètres de publication

Les paramètres de publication se configurent par déploiement et s’appliquent à toutes les personnes qui publient depuis l’éditeur. Ils contrôlent la façon dont les pull requests et les commits sont générés, ouverts et fusionnés. Vous devez disposer d’un accès administrateur à votre déploiement Mintlify pour modifier les paramètres de publication.

​
Instructions pour le message de commit

Les instructions pour le message de commit guident l’IA lorsqu’elle génère un message de commit pour une publication. L’éditeur les utilise dès que vous publiez sans saisir votre propre message. Utilisez les instructions pour le message de commit afin de respecter une convention existante dans votre dépôt, par exemple :
  • Conventional Commits (docs(editor): ...).
  • Un préfixe de ticket ou d’issue obligatoire.
  • Une longueur maximale d’objet plus stricte que les 72 caractères par défaut.
Exemple : 
Follow Conventional Commits. Use the "docs" type and an "editor" scope
for content changes (for example, "docs(editor): clarify quickstart steps").
Keep the subject under 60 characters.
Si votre dépôt impose une expression régulière sur le message de commit, l’éditeur la valide quand même après la génération.

​
Instructions pour la pull request

Les instructions pour la pull request guident l’IA lorsqu’elle génère le titre et la description d’une pull request. Elles s’appliquent dès que l’éditeur ouvre une pull request en votre nom, y compris dans les flux Create pull request et Merge and publish. Utilisez les instructions pour la pull request afin de standardiser ce que voient les relecteurs, par exemple :
  • Des sections obligatoires comme Summary et Changes.
  • Un modèle de description qui renvoie vers un système de suivi.
  • Des exigences de ton ou de longueur pour les titres.
Exemple : 
Title: imperative mood, under 70 characters, no trailing period.
Description: include a "## Summary" section (one sentence) and a
"## Changes" section as a bulleted list. Link any referenced page
using its relative path.

​
Créer les pull requests en brouillon par défaut

Activez cette option pour que l’éditeur ouvre chaque nouvelle pull request à l’état de brouillon. Vous ne pouvez pas fusionner une pull request en brouillon avant de la marquer comme prête pour la relecture. C’est utile quand :
  • Votre équipe exige une relecture manuelle avant d’ouvrir la pull request pour approbation.
  • Vous voulez partager les URLs de prévisualisation sans signaler que la modification est prête à être fusionnée.
Vous pouvez toujours marquer une pull request comme prête pour la relecture depuis votre fournisseur Git.

​
Méthode de fusion par défaut

Choisissez la manière dont l’éditeur fusionne les pull requests lorsque vous cliquez sur Merge and publish :
  • Merge : Crée un commit de fusion qui conserve l’historique complet de la branche.
  • Squash : Combine tous les commits de la branche en un seul commit sur votre branche de déploiement.
  • Rebase : Rejoue chaque commit de la branche sur votre branche de déploiement, sans commit de fusion.
La méthode sélectionnée est utilisée par défaut. Si vous passez une méthode de fusion explicite via l’API ou l’interface de votre fournisseur Git, ce choix prévaut.
Alignez votre méthode de fusion par défaut sur les règles de protection de branche de votre fournisseur Git. Si votre branche de déploiement n’autorise que les fusions squash, définissez la valeur par défaut sur Squash pour éviter les échecs de fusion depuis l’éditeur.