Page URLs and Slugs

Every page has a slug: the short, URL-friendly part of its address. Clean slugs make links readable, easier to share and better for search engines. DocStar builds each page's URL from its slug and the slugs of its parent pages.

#

How page URLs are built

A page's URL is the path of slugs from the top-level page down to the page itself.

Where the collection is published Example URL
Your custom domain https://docs.example.com/getting-started/install
Your custom domain with a path https://example.com/docs/getting-started/install
The DocStar domain .../p/getting-started/install?collectionId=...

Here getting-started is the parent page's slug and install is the subpage's slug. To set up your own domain, see Custom Domain.

#

Automatic slugs

A new page gets a temporary slug such as untitled-4821. When you rename the page for the first time, DocStar replaces that temporary slug with one based on the new name.

#

Change a page slug

You can change the slug in two places.

From the sidebar

  1. Hover over the page in the sidebar and click ....
  2. Click Rename.
  3. Edit the Page Slug field.
  4. Click Submit.

Copy of Copy of Untitled Design (4).jpg

From the page

  1. Open the page and click the settings (gear) icon in the top-right corner.
  2. Under Rename URL, click Rename.
  3. Enter the new slug and click Save.
#

Slug rules

  • Use letters, numbers, hyphens (-), underscores (_) and tildes (~). Spaces and other symbols aren't allowed.
  • Two pages under the same parent can't share a slug.
  • faq and changelog are reserved for top-level pages because DocStar uses them for your FAQ and changelog pages. DocStar suggests an alternative, such as _faq.
#

When a page's URL changes, DocStar redirects the old URL to the new one automatically. This happens when you:

  • change a page's slug, and
  • move a page to a different place with drag and drop.

The redirect also covers the page's subpages, whose URLs change with it. Visitors and search engines that use an old link land on the right page.

You can view and manage these redirects in Settings › Redirections. When you archive a page, DocStar also asks whether you want to add a redirection so its URL points somewhere useful. See Redirects.

#

Tips

  • Keep slugs short and descriptive, such as reset-password rather than how-to-reset-your-password-in-the-app.
  • Change slugs before you share links widely. Redirects protect old links, but stable URLs are still best for SEO. See SEO.
  • If DocStar says a URL mapping already exists, an existing redirect uses that path. Pick a different slug or remove the redirect first.
Built with DocStar