General settings
Rename a site, and understand the three different names a site has — display name, slug, and published title.
Rename a site, and understand the three different names a site has — display name, slug, and published title.
Settings → General holds a site’s basic settings. Today that’s the project name.
Edit the name and Save changes. Only owners and admins can rename a site; members see the field read-only.
This trips people up, because changing one does not change the others. They’re separate on purpose.
| Name | Where it shows | Where it’s set | Changeable |
|---|---|---|---|
| Display name | The dashboard — site switcher, breadcrumb, activity feed | Here, in General | Yes, any time |
| Slug | The site’s default web address | Set when you connect the site | No |
| Published title | The live docs site’s navbar and browser title | name in your repo’s docs.json | Yes, by editing your repo |
So renaming a site here changes what you and your teammates see in the dashboard. It doesn’t move the site’s URL, and readers won’t notice anything.
Want to change what readers see at the top of the docs? That’s the name field in your
repository’s docs.json — see organizing your docs. It updates on
the next build.
The slug is part of your site’s address, so changing it would break every existing link to your docs — including anything readers have bookmarked and anything search engines have indexed.
If you need a different public address, the better answer is a custom domain: it gives you the address you want without invalidating the old one, since the original keeps working.