Glossaire
Trouvez les définitions des termes Mintlify liés au produit, au contenu, à la navigation, au déploiement, à Git, aux API et à l'IA.
Utilisez ce glossaire comme référence rapide pour les termes utilisés dans Mintlify et dans l’ensemble de cette documentation. Pour un aperçu de l’articulation des différentes parties, consultez Concepts.
Un serveur Model Context Protocol authentifié qui permet aux outils d’IA autorisés de lire et de mettre à jour le contenu et les paramètres sur un ou plusieurs déploiements d’une organisation. Les modifications se font sur une branche et nécessitent une pull request pour être fusionnées. Consultez Admin MCP server.
Un outil d’IA destiné aux mainteneurs de documentation qui recherche, rédige, valide et publie des modifications proposées. L’agent peut ouvrir une pull request ou commiter sur la branche de déploiement, selon votre configuration. Consultez Agent.
Un lien de navigation persistant de premier niveau vers une destination interne ou externe. Les ancres constituent l’un des principaux schémas de navigation disponibles dans docs.json. Consultez Ancres.
Un environnement interactif sur les pages d’endpoints où les lecteurs élaborent, envoient et inspectent de véritables requêtes d’API sans quitter votre documentation. Mintlify génère le playground à partir d’un document OpenAPI. Consultez Vue d’ensemble du playground API.
Une interface d’IA destinée aux lecteurs de la documentation qui répond aux questions à partir de votre contenu. Il cite les pages pertinentes et peut diriger les utilisateurs directement vers le contenu approprié. L’assistant ne modifie pas votre documentation. Consultez Assistant.
Une tâche d’agent configurée qui s’exécute selon un calendrier, après une mise à jour du dépôt ou en réponse à un événement provenant d’une intégration connectée. Consultez Automations.
Une ligne de travail distincte dans un dépôt Git. Utilisez les branches pour effectuer et relire des modifications sans affecter le site en production. Consultez Concepts Git.
Le processus qui valide les fichiers de votre projet et les transforme en un site de documentation déployable. Un build peut produire le site en production ou un déploiement de prévisualisation.
Un instantané enregistré des modifications dans un dépôt Git. Publier depuis l’éditeur web crée un commit. Consultez Concepts Git.
Un élément MDX réutilisable pour présenter du contenu structuré ou interactif, tel qu’une carte, un encart, un accordéon, un onglet ou un groupe de code. Consultez Composants.
Le répertoire d’un dépôt qui contient docs.json et les fichiers d’un déploiement Mintlify. Il peut s’agir de la racine du dépôt ou d’un sous-répertoire configuré, comme docs/ dans un monorepo. Consultez Configuration monorepo.
Un dépôt supplémentaire que l’agent peut consulter pour obtenir des informations de fond lorsqu’il effectue une tâche. Un dépôt de contexte ne fait pas partie du site de documentation.
Des unités qui mesurent l’utilisation des fonctionnalités d’IA de Mintlify. Les crédits sont mutualisés au sein d’une organisation et partagés par ses déploiements et ses membres. Consultez Crédits.
Un domaine, sous-domaine ou sous-chemin que vous connectez à un site Mintlify au lieu d’utiliser son adresse .mintlify.site par défaut. Consultez Domaine personnalisé.
L’application Mintlify authentifiée où votre équipe édite le contenu, surveille les déploiements, gère les membres et configure les paramètres du projet et de l’organisation.
Un projet de documentation au sein d’une organisation Mintlify. Un déploiement connecte le contenu source et une branche de déploiement à un site en production. Le terme peut également désigner un build spécifique en cours de publication.
La branche Git utilisée pour construire le site en production, généralement main. Les modifications poussées ou fusionnées dans cette branche déclenchent un déploiement en production. Consultez Branche de déploiement.
Le fichier de configuration requis pour un site Mintlify. Il contrôle la navigation, l’apparence, les intégrations, les paramètres d’API, les redirections et d’autres comportements globaux. Consultez docs.json.
Une structure de navigation de premier niveau qui regroupe des sections associées dans un menu. Consultez Menus déroulants.
L’éditeur intégré au navigateur dans le tableau de bord Mintlify. Il offre l’édition collaborative, la sauvegarde automatique, les prévisualisations en direct, la synchronisation Git et les flux de publication. Consultez Vue d’ensemble de l’éditeur.
Toute branche autre que la branche de déploiement que vous utilisez pour préparer des modifications. Les branches de fonctionnalité maintiennent le travail inachevé séparé du site en production.
Métadonnées YAML au début d’une page MDX, encadrées par des lignes ---. Le frontmatter contrôle des propriétés telles que le titre de la page, la description, l’icône et la mise en page. Consultez Pages.
Une collection étiquetée de pages ou de groupes imbriqués dans la barre latérale. Les groupes organisent le contenu associé au sein d’une section de navigation. Consultez Groupes.
Un service de recherche pour les agents de codage qui récupère le contexte technique à jour à partir de la documentation maintenue par les éditeurs et du Web via un serveur MCP ou une API REST. Consultez Index.
Une connexion entre Mintlify et un autre service. Les intégrations peuvent fournir des analyses, un chat, des contrôles de confidentialité, des exemples de SDK, du contexte d’automatisation ou des déclencheurs d’automatisation.
Une version localisée de votre documentation configurée dans la navigation. Les langues créent des routes basées sur la locale et un sélecteur de langue. Consultez Langues.
Le rendu continuellement mis à jour de vos modifications non publiées dans l’éditeur web. Une prévisualisation en direct n’est pas déployée publiquement. Consultez Prévisualisation en direct.
Le site de documentation de production construit à partir de la branche de déploiement et accessible aux lecteurs sur un domaine Mintlify ou personnalisé.
Un fichier texte généré qui aide les outils d’IA à découvrir les pages les plus utiles d’un site de documentation. llms-full.txt inclut le contenu de toutes les pages dans un seul fichier. Consultez llms.txt.
Une syntaxe en texte brut permettant de formater du contenu avec des éléments tels que des titres, des listes, des liens et des blocs de code. Les pages Mintlify publiées sont également disponibles en Markdown en ajoutant .md à leur URL.
Markdown enrichi par JSX. Mintlify utilise des fichiers de page .mdx afin que vous puissiez combiner du Markdown standard avec des composants et des éléments React personnalisés.
L’opération Git qui combine les modifications d’une branche dans une autre. Fusionner une branche de fonctionnalité dans la branche de déploiement publie ses modifications via un nouveau build.
Un protocole ouvert qui permet aux applications d’IA de se connecter à des outils et à des sources de données. Mintlify propose un serveur MCP public en lecture seule pour chaque site publié ainsi qu’un serveur MCP d’administration authentifié pour gérer les déploiements.
La hiérarchie que les lecteurs utilisent pour se déplacer dans un site de documentation. Configurez la navigation dans votre fichier docs.json avec des pages, des groupes, des onglets, des menus déroulants, des produits, des versions, des langues et des ancres. Consultez Navigation.
Un format standard pour décrire les API HTTP. Mintlify peut générer des pages de points de terminaison, des exemples de requêtes et un playground d’API interactif à partir d’un document OpenAPI. Consultez Configuration OpenAPI.
Un espace de travail Mintlify qui contient les membres de l’équipe, les paramètres au niveau de l’organisation, les crédits partagés et un ou plusieurs déploiements.
Un document JSON ou YAML qui décrit des modifications à appliquer à une spécification OpenAPI sans éditer son fichier source. Mintlify applique les overlays avant de valider et d’afficher une spécification. Consultez Transformez votre spécification avec des overlays.
Un fichier .mdx qui est rendu comme une route sur votre site de documentation. Une page combine le frontmatter, le contenu Markdown et des composants optionnels. Consultez Pages.
Une version temporaire et partageable d’un site construite à partir d’une pull request ou d’une branche sélectionnée. Elle permet aux relecteurs d’inspecter les modifications avant qu’elles n’atteignent le site en production. Consultez Déploiements de prévisualisation.
Une structure de navigation de premier niveau permettant de publier de la documentation pour plusieurs produits distincts dans un seul déploiement. Chaque produit a sa propre navigation. Consultez Produits.
Un terme général désignant un déploiement Mintlify et son dépôt, sa configuration et son site associés. Dans les paramètres du tableau de bord et les API, déploiement est généralement le terme le plus précis.
Écrire les modifications de la documentation dans Git afin qu’elles puissent progresser vers le site en production. Selon la branche et les paramètres de relecture, la publication peut déployer directement, enregistrer un commit sur une branche ou créer une pull request.
Une proposition de fusion des modifications d’une branche Git dans une autre. Les pull requests prennent en charge la relecture, les discussions, les vérifications automatisées et les déploiements de prévisualisation avant que les modifications n’atteignent la branche de déploiement. GitLab appelle cela une merge request.
Une règle qui envoie les visiteurs d’une URL ancienne ou alternative vers une nouvelle destination. Les redirections préservent le bon fonctionnement des liens lorsque le contenu est déplacé. Consultez Redirections.
Une collection de fichiers et leur historique Git. Le dépôt de documentation est la source de vérité pour un site Mintlify et contient ses pages, sa configuration et ses ressources.
Contenu stocké dans un fichier séparé et importé dans une ou plusieurs pages MDX. Mettre à jour l’extrait source met à jour chaque page qui l’utilise. Consultez Extraits réutilisables.
Un fichier généré qui décrit les capacités et la documentation d’un produit à destination des agents d’IA. Les utilisateurs peuvent l’installer en tant que compétence d’agent afin d’améliorer les résultats lorsqu’ils travaillent avec le produit. Consultez skill.md.
Le dépôt qui contient le code du produit, les définitions d’API ou d’autres éléments décrits par la documentation. L’agent peut utiliser un dépôt source connecté comme contexte sans publier ses fichiers sur le site de documentation.
Une section de navigation de premier niveau pour des domaines parallèles de la documentation destinés au même public, tels que les guides et la référence d’API. Consultez Onglets.
La mise en page de base et le système visuel d’un site de documentation. Un thème contrôle la présentation globale, tandis que les couleurs, les polices, les logos et d’autres paramètres le personnalisent. Consultez Thèmes.
Une structure de navigation permettant de publier plusieurs versions de la même documentation en parallèle, telles que v1 et v2. Consultez Versions.