Some names in Mintlify can be changed at any time and others are fixed when they are created:
- Changeable: your deployment’s project name, your docs site name in
docs.json, and your custom domain.
- Fixed: your deployment’s subdomain and your organization’s name. Changing either requires deleting and recreating.
Rename your deployment’s project name
The project name is the display name shown in the dashboard topbar. To change it:
- Go to the General settings page in your dashboard.
- In the Deployment name field, enter the new name. Names must be 3 to 100 characters and contain only letters, numbers, hyphens, and underscores.
- Save your changes.
Renaming the project requires permission to update the deployment. If the field is disabled, contact an admin of your organization. See Roles and permissions.
Change your deployment’s subdomain
Your subdomain identifies your deployment. It appears in your <subdomain>.mintlify.app URL and in your dashboard URL, app.mintlify.com/<org>/<subdomain>. The subdomain cannot be changed after the deployment is created.
To use a different subdomain, create a new deployment with the name you want, then delete the old one:
- Create a new deployment connected to the same repository.
- If you use a custom domain, remove it from the old deployment, then add it to the new deployment. See Custom domain.
- Delete the old deployment from the Danger zone. See Delete a deployment.
Deleting a deployment is permanent and removes all deployment data, including analytics history and any associated preview deployments. Dashboard settings do not transfer to the new deployment, so reconfigure them after you create it.
Rename your organization
Organization names cannot be changed. To use a different organization name, create a new organization, recreate your deployments in it, and delete the old organization from the Danger zone. Deleting an organization is irreversible and requires the admin role.
What your readers see
Your subdomain and organization name are rarely visible to readers, so you may not need to rename anything:
- The site name displayed on your docs comes from the
name field in docs.json. You can change it at any time.
- The URL readers visit can be a custom domain like
docs.example.com, which you can add or change at any time.
