La façon dont vos modifications sont publiées dépend de la branche sur laquelle vous travaillez :
  • Branche de déploiement : La publication met immédiatement à jour votre site en ligne.
  • Autres branches : La publication crée une pull request afin que vous puissiez revoir les modifications avant leur déploiement en production.
Le bouton Publish mis en évidence dans l’Éditeur web Mintlify

​
Pull requests et revue des changements

Les pull requests vous permettent de proposer des modifications depuis votre branche afin que d’autres puissent les revoir avant de les fusionner dans votre documentation en production. Cela aide à garantir l’exactitude de vos changements et donne à votre équipe l’occasion de collaborer sur le contenu.
Même si vous travaillez seul, les pull requests sont utiles pour prévisualiser les changements et maintenir un historique clair des mises à jour.

​
Créer une pull request

1

Enregistrer votre travail

Assurez-vous que toutes vos modifications sont enregistrées sur votre branche en utilisant Save Changes.
2

Créer la pull request

Sélectionnez Publish Pull Request dans le coin supérieur droit de l’éditeur.
3

Ajouter un titre et une description

Rédigez un titre et une description clairs expliquant :
  • Les modifications que vous avez effectuées
  • Pourquoi vous les avez effectuées
  • Les points spécifiques à examiner
4

Créer et partager

Sélectionnez Publish Pull Request. L’éditeur fournira un lien pour afficher votre pull request.
Bouton Publish Pull Request mis en évidence dans l’éditeur web Mintlify

​
Examiner les pull requests

Une fois votre pull request créée :
  1. Examiner les modifications : Vous et les membres de votre équipe pouvez examiner votre pull request dans votre plateforme Git, comme GitHub ou GitLab.
  2. Laisser des retours : Ajoutez des commentaires ou demandez des modifications.
  3. Apporter des modifications supplémentaires : Apportez des modifications supplémentaires dans l’Éditeur web. Lorsque vous enregistrez, l’éditeur les envoie vers votre pull request.
  4. Approuver : Approuvez la pull request lorsque vous êtes satisfait des modifications.
  5. Fusionner : Fusionnez la pull request lorsque vous êtes prêt à déployer vos modifications en production.