You can change some names in Mintlify at any time. Others are fixed when you create them:
- Changeable: your organization’s name, your project’s name, your docs site name in
docs.json, and your custom domain.
- Fixed: your project’s subdomain and your organization’s slug. Changing either requires deleting and recreating.
Rename your project
The project name is the display name for your project in the dashboard. To change it:
- Go to the General settings page in your dashboard.
- In the Project 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 project. If the field is disabled, contact an admin of your organization. See Roles and permissions.
Change your project’s subdomain
Your subdomain identifies your project. It appears in your <subdomain>.mintlify.app URL and in your dashboard URL, app.mintlify.com/<org>/<subdomain>. You cannot change the subdomain after you create the project.
To use a different subdomain, create a new project with the name you want, then delete the old one:
- Create a new project connected to the same repository.
- If you use a custom domain, remove it from the old project, then add it to the new project. See Custom domain.
- Delete the old project from the Danger zone section of the Organization settings page. See Delete a project.
Deleting a project is permanent and removes all project data, including analytics history and any associated preview deployments. Dashboard settings do not transfer to the new project, so reconfigure them after you create it.
Rename your organization
The organization name is the workspace display name shown across the dashboard. To change it:
- Go to the Organization general settings page in your dashboard.
- In the Name field under Workspace, enter the new name.
- Select Save.
Renaming the organization requires permission to update the organization. If the field is disabled, contact an admin of your organization. See Roles and permissions.
Change your organization’s slug
Your organization’s slug is the unique identifier that appears in your dashboard URL, app.mintlify.com/<org>/<subdomain>. You cannot change the slug after you create the organization. To use a different slug, create a new organization and recreate your projects in it. Then delete the old organization from the Danger zone section of the Organization settings page. 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.
