Configuring docs URLs

🔍

HelpWP lets you choose how individual doc URLs are built. The setting lives in HelpWP -> Settings -> Docs -> Permalink as a radio list.

The base slug

The base slug is the slug of the page you picked under Docs -> Pages -> Docs archive page (typically docs, documentation, or help). All URL templates below sit underneath that base.

If your archive page slug is docs, the templates produce URLs like:

Structure	Resulting URL
docs/doc-slug	/docs/getting-started/
docs/<product-slug>/doc-slug	/docs/helpwp/getting-started/
docs/<topic-slug>/doc-slug	/docs/setup/getting-started/
docs/<topic-slug>/<product-slug>/doc-slug	/docs/setup/helpwp/getting-started/
docs/<product-slug>/<topic-slug>/doc-slug	/docs/helpwp/setup/getting-started/

The plugin also offers four templates without the base slug, where the product or topic slug sits at the site root:

Structure	Resulting URL
<product-slug>/doc-slug	/helpwp/getting-started/
<topic-slug>/doc-slug	/setup/getting-started/
<topic-slug>/<product-slug>/doc-slug	/setup/helpwp/getting-started/
<product-slug>/<topic-slug>/doc-slug	/helpwp/setup/getting-started/

Picking the right structure

• If you have a single product line, the simple docs/doc-slug is cleanest.
• If you cover several products on one site, prefix the URL with the product slug so the URL reflects what the article is about.
• If your knowledge base is organized by topic (Setup, Billing, API), use the topic-prefixed structures.
• The root-level structures (no docs/ prefix) are useful when you want your knowledge base to look like a regular section of the site.

After changing the setting

WordPress caches rewrite rules. Saving the permalink setting flushes them automatically, so you do not need to visit Settings -> Permalinks afterwards. Old URLs still work for a short while via the canonical redirect, but external links should be updated.