Skip to main content
Support

Editing Article Metadata

When you first get started writing your articles, you'll notice a lot of the advanced stuff is automatically done for you. However, if you're a whizz and want to customize the way things are displayed on your knowledge base, you can!

Taylor
Updated by Taylor
2 min read
Table of Contents

When you first start writing articles, you'll notice many advanced features are automatically handled for you. But if you're feeling adventurous and want to customize how things appear on your Knowledge Base, you absolutely can!

You can now generate these automatically using HelpDocs AI ✨
What's an article slug?

We're not talking about garden creatures here. A slug is the end of the URL that appears in your address bar 🐌

In the example below, the pink part is automatically generated to prevent URL conflicts (you can turn this off but we don't recommend it). The green part is the slug that you can customize. If another article already uses the slug you type, we'll warn you and link to that article.

What's an article description?

This is a brief preview of your article content, typically a sentence or two that gives visitors a quick idea about the article before they click.

We automatically pull this from your article introduction, but you can customize it to better reflect your content or improve SEO.

Managing users with roles and access.

What's the article short version?

The short version is exactly what it sounds like, a condensed version of your article. Leave it blank and we'll create one automatically.

It's available through the API and in custom templates, letting you build custom integrations. It's also used in the Front plugin and Intercom Messenger integrations.

The Short Version field in Article details, filled in with a condensed version of the article

Editing Article Metadata

  1. Head to your article
  2. Click Pencil icon Article details in the top navigation
  3. A panel will open where you can edit the Slug, Description, and Short Version. It's also where you set your article's Icon, Tags, Table of Contents, and Featured status
  4. Hit Apply changes & close
  5. Hit Save
  6. Hit Publish to make everything live
Remember that changing the slug will also change your article's URL if you're using the alternate links style, creating a broken link. On a published article, turn on Create redirect on save (it appears under the slug when you change it), or set up a redirect yourself.

What did you think of this doc?

Previous Adding Custom Navigation Links Next Adding Multiple Domains

Get in touch