Configuration d’un monorepo

Configurez Mintlify pour déployer la documentation depuis un répertoire spécifique au sein d’un monorepo. Cette configuration vous permet de conserver la documentation aux côtés de votre code dans des référentiels contenant plusieurs projets ou services.

Une structure de monorepo typique pourrait ressembler à ceci :

your-repo/
├── apps/
│   ├── web/
│   └── api/
├── docs/
│   ├── docs.json
│   └── quickstart.mdx
└── package.json

Dans cet exemple, vous définiriez le chemin de votre documentation sur /docs.

• Accès administrateur à votre projet Mintlify.
• Fichiers de documentation organisés dans un répertoire dédié au sein de votre monorepo.
• Un fichier docs.json valide dans votre répertoire de documentation.

Accéder aux paramètres Git

Accédez à Git Settings dans votre Dashboard.

Définir le chemin de votre documentation

1. Activez l’option docs.json is in a subdirectory.
2. Saisissez le chemin relatif vers votre répertoire de documentation. Par exemple, si votre documentation se trouve dans le répertoire docs, saisissez /docs.

N’incluez pas de barre oblique finale dans le chemin.

3. Sélectionnez Enregistrer les modifications. L’enregistrement déclenche un nouveau déploiement à partir du chemin configuré.