Collaborer dans l’éditeur web

Modifiez la documentation avec votre équipe grâce à la collaboration en temps réel, aux curseurs en direct, aux liens partageables de l’éditeur, aux branches et aux workflows de revue par pull request.

Collaborez avec votre équipe sur la documentation en utilisant l’édition en temps réel et des workflows basés sur des branches.

​

Collaboration en temps réel

Plusieurs personnes peuvent modifier la même page en même temps. Les modifications de chacun apparaissent pour toutes les personnes sur la page.

Pour collaborer sur une page en temps réel, partagez le lien de l’éditeur de cette page avec vos coéquipiers. Voir Partager des liens de l’éditeur ci-dessous.

​

Fonctionnement de l’édition en temps réel

Lorsque plusieurs membres de l’équipe modifient la même branche, les changements se synchronisent en temps réel. Les mises à jour du contenu des pages, de la structure de navigation et de la configuration du site apparaissent automatiquement pour tous les collaborateurs sans rafraîchissement.

• Le curseur et les modifications de chaque personne sont visibles par tous les utilisateurs présents sur la page, avec les avatars et les noms affichés dans la barre d’outils.
• Les modifications fusionnent automatiquement. Deux personnes qui modifient la même section ne provoquent pas de conflits.
• L’annulation n’affecte que vos propres modifications — annuler ne revient pas sur les modifications d’une autre personne.
• Si vous perdez votre connexion réseau, vos modifications sont enregistrées localement et synchronisées dès que vous vous reconnectez.

​

Voir les modifications de l’agent en temps réel

Lorsque l’agent Mintlify modifie une page via l’API ou MCP, il apparaît dans l’éditeur web comme tout autre collaborateur. Si vous avez la page ouverte sur la même branche, vous voyez l’avatar et le nom de l’agent en haut de l’éditeur et un curseur en direct à l’emplacement de sa dernière modification.

Utilisez cela pour :

• Observer en direct les modifications de l’agent apparaître sur la page.
• Voir quel paragraphe ou bloc l’agent vient de mettre à jour sans avoir à comparer le fichier.
• Vous coordonner avec vos coéquipiers et l’agent sur la même branche sans écraser le travail des autres.

Le curseur de l’agent disparaît automatiquement peu après que l’agent a fini d’éditer.

​

Collaboration basée sur des branches

Utilisez des branches pour travailler en parallèle sur les mises à jour de votre documentation sans affecter votre site en production. Si vous ne connaissez pas bien Git, consultez Notions essentielles Git pour l’éditeur web.

​

Pourquoi utiliser des branches

• Isoler les modifications : Travaillez sur des mises à jour sans affecter votre documentation en ligne.
• Relire avant la publication : Obtenez des retours de la part des membres de l’équipe avant que les modifications ne soient mises en ligne.
• Travail en parallèle : Plusieurs membres de l’équipe peuvent travailler sur différentes branches simultanément.

​

Workflow recommandé

Utilisez des pull requests (demandes de fusion) pour proposer des modifications et collaborer avec votre équipe avant de les fusionner dans votre documentation en production. Ce workflow garantit que votre équipe relit les modifications avant la publication et conserve un historique clair des mises à jour.

1. Créer une pull request

   Créez une pull request depuis l’éditeur lorsque vous êtes prêt à publier vos modifications. Consultez Branching and publishing pour plus d’informations.

2. Examiner les pull requests

   Examinez les pull requests sur votre plateforme Git, comme GitHub ou GitLab.

3. Répondre aux commentaires

   Lorsque les relecteurs demandent des modifications, appliquez les changements demandés dans l’éditeur. Les modifications supplémentaires sont automatiquement envoyées vers la pull request existante.

4. Fusionner les pull requests

   Fusionnez votre pull request après avoir pris en compte toutes les modifications demandées, que les relecteurs requis l’ont approuvée et que toutes les vérifications automatisées ont réussi.

​

Déploiements de prévisualisation

Les déploiements de prévisualisation créent des URL temporaires où vous pouvez voir le rendu de vos modifications avant leur mise en ligne. Utilisez les déploiements de prévisualisation pour recueillir des retours sur vos modifications.

Chaque fois que vous publiez des modifications sur une branche, le déploiement de prévisualisation se met à jour automatiquement.

​

Accéder aux déploiements de prévisualisation

1. Cliquez sur Publish dans la barre d’outils de l’éditeur.
2. Cliquez sur l’URL de prévisualisation pour ouvrir le déploiement de prévisualisation dans un nouvel onglet. Le format de l’URL est organization-branch-name.mintlify.app.

​

Partager les prévisualisations

Partagez l’URL du déploiement de prévisualisation avec les membres de l’équipe pour recueillir leurs retours. Les prévisualisations se mettent automatiquement à jour lorsque vous publiez des modifications supplémentaires.

​

Authentification pour la prévisualisation

Les URL de prévisualisation sont accessibles publiquement par défaut. Activez l’authentification de prévisualisation sur la page Modules complémentaires de votre dashboard pour restreindre l’accès aux membres authentifiés de l’organisation.

​

Partager des liens de l’éditeur

Partagez un lien direct vers une page spécifique dans l’éditeur avec vos collègues. Utilisez les liens de l’éditeur pour collaborer en temps réel sur des mises à jour ou diriger vos collègues vers une page spécifique.

L’URL de l’éditeur se met à jour automatiquement lorsque vous naviguez entre les pages. Copiez l’URL depuis la barre d’adresse de votre navigateur pour la partager avec les collègues qui ont accès à l’éditeur.

Le format de l’URL est : https://dashboard.mintlify.com/{org}/{project}/editor/{branch}/~/{filepath}

Par exemple, https://dashboard.mintlify.com/acme/docs/editor/main/~/guides/quickstart.mdx ouvre le fichier quickstart.mdx sur la branche main.

Toute personne ayant accès à votre organisation Mintlify peut utiliser le lien pour ouvrir le fichier directement dans l’éditeur.