mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
eed7384340
* docs: fix editor button label, CLI groups flag, BYOK coverage, and draft PR setting * docs: mirror PR changes into es, fr, zh and fix overlong translated descriptions * docs: clarify branch publishing and draft PR review steps * Apply batched suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
140 lines
7.1 KiB
Plaintext
140 lines
7.1 KiB
Plaintext
---
|
|
title: "Paramètres de l'éditeur pour l'IA et la publication"
|
|
sidebarTitle: "Paramètres"
|
|
description: "Configurez l'apparence, les instructions d'IA et les réglages de publication de l'éditeur, dont la façon dont il commit et fusionne les modifications."
|
|
keywords: ["editor", "settings", "ai", "instructions", "publishing", "pull request", "merge", "appearance", "preferences"]
|
|
---
|
|
|
|
La [page de paramètres](https://app.mintlify.com/settings/deployment/editor) de l'éditeur contrôle l'apparence, le comportement de publication et le comportement de l'agent.
|
|
|
|
- **Appearance** : Préférences personnelles sur l'aspect et le comportement de l'éditeur. Elles ne s'appliquent qu'à vous.
|
|
- **Publishing** : Valeurs par défaut, à l'échelle du deployment, sur la façon dont l'éditeur commit les modifications et ouvre les pull requests. Elles s'appliquent à toutes les personnes qui publient. Leur modification nécessite l'autorisation de mettre à jour le deployment. Si les contrôles sont désactivés pour vous, contactez un admin.
|
|
- **Chat** : Instructions persistantes pour l'agent d'IA de l'éditeur.
|
|
- **Danger zone** : Actions irréversibles.
|
|
|
|
<div id="appearance">
|
|
|
|
## Appearance
|
|
|
|
</div>
|
|
|
|
Les paramètres d'apparence sont des préférences personnelles. Ils ne modifient l'éditeur que pour vous et n'affectent ni vos coéquipiers ni votre site publié.
|
|
|
|
- **Fit editor to full width** : Étend la zone d'édition d'un bord à l'autre au lieu de la colonne de 768px par défaut.
|
|
- **Show breadcrumbs** : Affiche l'emplacement de la page dans la navigation du site au-dessus de la zone d'édition.
|
|
- **Open live preview in new tab** : Ouvre la page rendue dans un nouvel onglet du navigateur lors de la prévisualisation, au lieu de l'aperçu en volet partagé.
|
|
- **Show all files** : Affiche tous les fichiers dans la barre latérale, y compris les dotfiles, le code, les PDF et les autres fichiers masqués par défaut. Vous pouvez aussi appuyer sur <kbd>Cmd</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (macOS) ou <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>.</kbd> (Windows) pour basculer l'affichage.
|
|
|
|
<div id="pr-instructions">
|
|
|
|
## Instructions de PR
|
|
|
|
</div>
|
|
|
|
Les instructions de PR guident l'IA lorsqu'elle génère le titre et la description d'une pull request. Elles s'appliquent chaque fois que l'éditeur ouvre une pull request en votre nom, y compris depuis les flux **Create pull request** et **Merge and publish**.
|
|
|
|
Utilisez les instructions de PR pour normaliser 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 :
|
|
|
|
```text
|
|
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.
|
|
```
|
|
|
|
Les instructions sont limitées à 20 000 caractères.
|
|
|
|
<div id="main-branch-autocommits">
|
|
|
|
## Autocommits sur la branch main
|
|
|
|
</div>
|
|
|
|
Les autocommits sur la branch main poussent vos modifications vers votre branch main automatiquement, peu après que vous arrêtez d'écrire. Si vous activez ce paramètre, l'éditeur **masque entièrement les branches et l'étape de publication**.
|
|
|
|
<Warning>
|
|
Avec les autocommits sur la branch main activés, il n'y a ni état en attente ni possibilité de relecture. Chaque modification atteint votre site publié peu après que vous arrêtez d'écrire.
|
|
</Warning>
|
|
|
|
<div id="create-draft-pull-requests-by-default">
|
|
|
|
## Créer les pull requests en brouillon par défaut
|
|
|
|
</div>
|
|
|
|
Lorsque ce paramètre est activé, les pull requests créées depuis l'éditeur s'ouvrent en brouillon. Les auteurs les marquent comme prêtes à être relues lorsqu'ils ont terminé leurs modifications. Ce paramètre est activé par défaut.
|
|
|
|
Désactivez-le si vous voulez que les pull requests de l'éditeur s'ouvrent immédiatement prêtes à être relues.
|
|
|
|
<div id="pr-merge-method">
|
|
|
|
## Méthode de fusion des PR
|
|
|
|
</div>
|
|
|
|
Choisissez comment l'éditeur fusionne les pull requests lorsque vous cliquez sur **Merge and publish** :
|
|
|
|
- **Merge** : Crée un commit de fusion qui conserve tout l'historique de la branch. C'est l'option par défaut.
|
|
- **Squash** : Combine tous les commits de la branch en un seul commit sur votre deployment branch.
|
|
- **Rebase** : Rejoue chaque commit de la branch sur votre deployment branch sans commit de fusion.
|
|
|
|
Si vous transmettez une méthode de fusion explicite via l'API ou l'interface de votre fournisseur Git, ce choix l'emporte.
|
|
|
|
<Tip>
|
|
Faites correspondre votre méthode de fusion aux règles de protection de branch de votre fournisseur Git. Si votre deployment branch n'autorise que les squash merges, choisissez **Squash** pour éviter les fusions en échec depuis l'éditeur.
|
|
</Tip>
|
|
|
|
<div id="ai-instructions">
|
|
|
|
## Instructions d'IA
|
|
|
|
</div>
|
|
|
|
Les instructions d'IA sont des consignes persistantes que l'éditeur transmet à l'IA en même temps que votre demande. Utilisez-les pour consigner les 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 :
|
|
|
|
- Aux actions **Edit with AI** sur une sélection, comme réécrire, développer ou corriger.
|
|
- Aux sessions de l'agent lancées depuis l'éditeur.
|
|
|
|
Chaque membre de l'équipe gère ses propres instructions, liées à son compte utilisateur. Les instructions sont limitées à 20 000 caractères.
|
|
|
|
Ajoutez des instructions d'IA lorsque vous constatez que vous répétez les mêmes consignes dans vos prompts, par exemple :
|
|
|
|
- Imposer la deuxième personne ou des titres en casse de phrase.
|
|
- Privilégier des noms de produit ou une terminologie précis.
|
|
- Interdire le langage marketing ou les formules de remplissage.
|
|
- Exiger certains composants, comme toujours utiliser `<Note>` pour les encadrés.
|
|
|
|
Gardez des instructions courtes et précises. L'IA les suit à chaque demande, donc des règles vagues ou contradictoires dégradent les résultats.
|
|
|
|
Exemple :
|
|
|
|
```text
|
|
- 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.
|
|
|
|
<div id="reset-editor">
|
|
|
|
## Réinitialiser l'éditeur
|
|
|
|
</div>
|
|
|
|
**Reset editor** force l'éditeur à abandonner son état local et à se synchroniser avec votre dépôt Git. Réinitialisez l'éditeur s'il reste désynchronisé par rapport à votre dépôt, par exemple si l'arborescence de fichiers est vide ou affiche des erreurs comme `Unable to find docs.json`. Cela peut se produire alors même que le fichier existe sur votre deployment branch et que votre site se compile normalement.
|
|
|
|
<Warning>
|
|
Si vous réinitialisez l'éditeur, vous perdez toutes les modifications non publiées que vous n'avez pas commitées dans Git. Si vous avez des modifications en attente que vous voulez conserver, publiez-les d'abord.
|
|
</Warning>
|