Certains noms dans Mintlify peuvent être modifiés à tout moment, tandis que d’autres sont fixés à la création :
- Modifiables : le nom de projet de votre déploiement, le nom de votre site de documentation dans
docs.json et votre domaine personnalisé.
- Fixes : le sous-domaine de votre déploiement et le nom de votre organisation. Modifier l’un ou l’autre nécessite de supprimer puis de recréer.
Renommer le nom de projet de votre déploiement
Le nom de projet est le nom d’affichage visible dans la barre supérieure du tableau de bord. Pour le modifier :
- Accédez à la page des paramètres généraux de votre tableau de bord.
- Dans le champ Deployment name, saisissez le nouveau nom. Les noms doivent comporter de 3 à 100 caractères et ne contenir que des lettres, des chiffres, des tirets et des tirets bas.
- Enregistrez vos modifications.
Renommer le projet nécessite l’autorisation de mettre à jour le déploiement. Si le champ est désactivé, contactez un admin de votre organisation. Consultez Rôles et autorisations.
Changer le sous-domaine de votre déploiement
Votre sous-domaine identifie votre déploiement. 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 déploiement.
Pour utiliser un autre sous-domaine, créez un nouveau déploiement avec le nom souhaité, puis supprimez l’ancien :
- Créez un nouveau déploiement connecté au même dépôt.
- Si vous utilisez un domaine personnalisé, retirez-le de l’ancien déploiement, puis ajoutez-le au nouveau. Consultez Domaine personnalisé.
- Supprimez l’ancien déploiement depuis la Zone de danger. Consultez Supprimer un déploiement.
La suppression d’un déploiement est définitive et efface toutes les données du déploiement, 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 déploiement ; reconfigurez-les après sa création.
Renommer votre organisation
Les noms d’organisation ne peuvent pas être modifiés. Pour utiliser un autre nom d’organisation, créez une nouvelle organisation, recréez-y vos déploiements, puis supprimez l’ancienne organisation depuis la Zone de danger. 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.