Configuration des références SDK

Utilisez la propriété de navigation sdk pour générer des pages de référence pour vos bibliothèques SDK à partir des outils de documentation que vous exécutez déjà. Mintlify lit l’artefact de build de chaque outil et crée une page pour chaque classe, interface, module et fonction. Les groupes de navigation, les liens entre les pages et l’indexation pour la recherche sont également inclus.

Exécutez votre outil de documentation avec un format de sortie lisible par machine. Si vous publiez déjà de la documentation générée depuis votre CI, il s’agit généralement de l’ajout d’un seul flag à la même commande.

npx typedoc --json typedoc.json src/index.ts

Ajoutez une propriété sdk à un onglet ou à un groupe dans votre docs.json. Mintlify analyse l’artefact et crée des groupes de navigation et des pages pour la bibliothèque.

"navigation": {
  "tabs": [
    {
      "tab": "SDK Reference",
      "sdk": {
        "format": "typedoc",
        "source": "sdk-artifacts/typedoc.json",
        "directory": "sdk/typescript"
      }
    }
  ]
}

Ajoutez sdk à un groupe pour générer des pages dans une section d’un onglet plutôt que dans l’onglet entier. Les groupes et pages héritent des paramètres sdk de l’onglet ou du groupe parent. Si un groupe imbriqué définit son propre sdk, Mintlify utilise ces paramètres à la place de ceux hérités.

{
  "group": "TypeScript SDK",
  "sdk": {
    "format": "typedoc",
    "source": "sdk-artifacts/typedoc.json",
    "directory": "sdk/typescript"
  },
  "pages": ["sdk/typescript/overview"]
}

Un groupe avec sdk peut aussi lister des pages que vous rédigez vous-même. Vos pages apparaissent en premier, suivies des groupes de référence générés.

Ajoutez plusieurs onglets ou groupes pour documenter plusieurs bibliothèques. Par exemple, utilisez deux groupes dans le même onglet pour les versions stable et bêta d’un SDK. Utilisez un directory unique pour chaque bibliothèque afin d’éviter les collisions de routes.

Mintlify ajoute les groupes de navigation générés après les éventuels groups de l’onglet. Si vous ajoutez sdk à un groupe, les groupes générés apparaissent après les pages de ce groupe. Les groupes varient selon le format et peuvent représenter des modules, des packages, des espaces de noms ou des types de symboles.

Chaque page générée documente une classe, une interface, une fonction, un type ou un autre symbole de l’artefact et renvoie vers les pages générées associées. Si un convertisseur produit des pages qui n’appartiennent à aucun groupe, Mintlify les regroupe sous un groupe Reference.

Utilisez le frontmatter sdk sur une page MDX pour cibler un seul symbole de l’artefact. Mintlify affiche le contenu que vous rédigez, puis ajoute la référence générée pour ce symbole en dessous. Utilisez cette approche lorsque vous souhaitez ajouter des exemples, des notes de migration ou du contexte au-dessus d’une classe, d’une interface ou d’une méthode spécifique.

Ajoutez la page à la navigation de votre docs.json, comme n’importe quelle autre page. Mintlify ne génère du contenu SDK que pour les pages qui apparaissent dans votre navigation.

Dès qu’un onglet ou un groupe avec sdk contient une page avec un frontmatter sdk, Mintlify cesse de remplir automatiquement cet onglet ou ce groupe et n’affiche que les pages que vous avez rédigées. Déplacez la page hors de l’onglet ou du groupe si vous souhaitez que le reste de la bibliothèque soit rempli automatiquement.

Pointez sdk vers un symbole :

---
title: "Client"
sdk: "class Client"
---

Créez un `Client` pour appeler l’API.

La forme chaîne suit le modèle [source] kind name. Si vous omettez source, la page l’hérite de la configuration sdk de l’onglet ou du groupe. La forme chaîne hérite toujours de format et ne fonctionne donc que sur les pages situées sous un onglet ou un groupe avec sdk. Dans tous les autres cas, définissez sdk comme un objet avec les champs ci-dessous. Pour les méthodes et propriétés, incluez le nom du parent, par exemple method Client.getUser.

Si vous omettez title ou description, Mintlify utilise le titre et la description générés pour le symbole.

Définissez source sur une URL HTTPS pour récupérer l’artefact au moment du build au lieu de le committer dans votre dépôt de documentation.

Les formats à fichier unique (typedoc, phpdoc) acceptent une URL de fichier directe. Les formats à répertoire (docfx, javadoc, sphinx) acceptent une archive zip. Les jars Javadoc publiés sur Maven Central fonctionnent sans reconditionnement :

{
  "tab": "Java SDK",
  "sdk": {
    "format": "javadoc",
    "source": "https://repo1.maven.org/maven2/com/example/my-library/1.0.0/my-library-1.0.0-javadoc.jar",
    "directory": "sdk/java"
  }
}

Les artefacts distants ont une limite de téléchargement de 50 Mo et une limite de taille extraite de 200 Mo.

Régénérez l’artefact chaque fois que votre SDK change. Un modèle courant consiste à configurer un job CI dans chaque dépôt de SDK. Ce job exécute l’outil de documentation à chaque publication, puis commite l’artefact dans votre dépôt de documentation ou le téléverse vers une URL stable référencée par source.

Stockez le code de votre SDK et votre documentation dans le même dépôt ou dans des dépôts séparés. Choisissez le modèle qui correspond à votre configuration. Les deux options offrent les mêmes fonctionnalités.

Générez l’artefact de votre SDK dans le même dépôt que votre documentation et indiquez son chemin relatif dans source. Tout workflow qui produit déjà l’artefact lors d’un push ou d’une publication peut le commiter dans le dépôt, puis publier les mises à jour lors du prochain déploiement du site de documentation.

docs-repo/
  docs.json
  content/
  sdk-artifacts/
    typedoc.json

Lorsque le SDK se trouve dans son propre dépôt, vous avez deux options.

1. Commiter l’artefact dans votre dépôt de documentation. Dans le dépôt du SDK, exécutez un job CI lors d’une publication pour générer l’artefact et ouvrir une pull request (ou pousser un commit) vers votre dépôt de documentation avec le fichier mis à jour. Fusionnez cette modification dans votre branche de déploiement pour déclencher un déploiement du site. Définissez source sur le chemin commité, comme pour la configuration avec un seul dépôt.

2. Héberger l’artefact et le récupérer au moment du build. Téléversez l’artefact vers une URL HTTPS stable. Par exemple, un bucket S3, un asset GitHub Releases ou Maven Central pour des jars Javadoc. Définissez source sur l’URL. Déclenchez un déploiement du site de documentation pour récupérer le nouvel artefact chaque fois que vous le mettez à jour. Appelez l’endpoint Déclencher un déploiement depuis le pipeline de publication de votre SDK après avoir publié l’artefact.