Passer au contenu principal
Certains noms dans Mintlify peuvent être modifiés à tout moment, tandis que d’autres sont fixés à la création :
  • Modifiables : le nom de votre organisation, le nom de votre projet, le nom de votre site de documentation dans docs.json et votre domaine personnalisé.
  • Fixes : le sous-domaine de votre projet et le slug de votre organisation. Modifier l’un ou l’autre nécessite de supprimer puis de recréer.

Renommer votre projet

Le nom du projet est le nom d’affichage de votre projet dans le tableau de bord. Pour le modifier :
  1. Accédez à la page des paramètres généraux de votre tableau de bord.
  2. Dans le champ Project name, saisissez le nouveau nom. Les noms doivent comporter de 3 à 100 caractères sur une seule ligne. Vous pouvez utiliser des espaces, de la ponctuation, des caractères non latins et des emojis. Mintlify supprime les espaces en début et en fin de nom lors de l’enregistrement.
  3. Enregistrez vos modifications.
Renommer le projet nécessite l’autorisation de mettre à jour le projet. Si le champ est désactivé, contactez un admin de votre organisation. Consultez Rôles et autorisations.

Changer le sous-domaine de votre projet

Votre sous-domaine identifie votre projet. Il apparaît dans votre URL <subdomain>.mintlify.app et dans l’URL de votre tableau de bord, app.mintlify.com/<org>/<subdomain>. Le sous-domaine ne peut pas être modifié après la création du projet. Pour utiliser un autre sous-domaine, créez un nouveau projet avec le nom souhaité, puis supprimez l’ancien :
  1. Créez un nouveau projet connecté au même dépôt.
  2. Si vous utilisez un domaine personnalisé, retirez-le de l’ancien projet, puis ajoutez-le au nouveau. Consultez Domaine personnalisé.
  3. Supprimez l’ancien projet depuis la section Zone de danger de la page General des paramètres de votre organisation. Consultez Supprimer un projet.
La suppression d’un projet est définitive et efface toutes les données du projet, y compris l’historique des analytics et les déploiements de prévisualisation associés. Les paramètres du tableau de bord ne sont pas transférés vers le nouveau projet ; reconfigurez-les après sa création.

Renommer votre organisation

Le nom de l’organisation est le nom d’affichage visible dans le tableau de bord. Pour le modifier :
  1. Accédez à la page des paramètres généraux de l’organisation de votre tableau de bord.
  2. Dans le champ Name sous Organization, saisissez le nouveau nom.
  3. Sélectionnez Save.
Renommer l’organisation nécessite l’autorisation de mettre à jour l’organisation. Si le champ est désactivé, contactez un admin de votre organisation. Consultez Rôles et autorisations.

Changer le slug de votre organisation

Le slug de votre organisation est l’identifiant unique qui apparaît dans l’URL de votre tableau de bord, app.mintlify.com/<org>/<subdomain>. Le slug ne peut pas être modifié après la création de l’organisation. Pour utiliser un autre slug, créez une nouvelle organisation, recréez-y vos projets, puis supprimez l’ancienne organisation depuis la section Zone de danger de la page General des paramètres de votre organisation. La suppression d’une organisation est irréversible et nécessite le rôle admin.

Ce que voient vos lecteurs

Votre sous-domaine et le nom de votre organisation sont rarement visibles par les lecteurs, il se peut donc que vous n’ayez rien à renommer :
  • Le nom du site affiché sur votre documentation provient du champ name dans docs.json. Vous pouvez le modifier à tout moment.
  • L’URL visitée par les lecteurs peut être un domaine personnalisé comme docs.example.com, que vous pouvez ajouter ou modifier à tout moment.