Within Teamwork Desk, you can use categories
to group your help articles into
easy-to-navigate
locations.
Create a category
π Only
administrators can manage
Help Docs categories.
- Select Help
Docs from Teamwork Desk's
main navigation menu.
- Click the relevant Help Docs site card
to view it.
- Switch to
the Categories tab.
- Click Add Category in the top right.
- Fill out the category's details:
- Category name
- Nest category under β leave blank to make it a top level category or choose to nest it under an existing category.π Category nesting can be a maximum of three levels deep (including the top-level category).
- Show on homepage β include it as one of the categories displayed on the Help Docs site's homepage.
- Slug β add a custom slug
(the
final part
of the URL that represents the
article).
If left blank, the article title
will be
used. Ex. if the slug is
βpasswordsβ
then the page URL might be
yoursite.helpdocsite.com/passwords.
- Old URL β include a link to
an
older
version of the content so readers
are redirected to the new
page.
- Click Add category.
Create a
subcategory
- Switch to
the Help Docs
site's Categories tab.
- Scroll to the relevant category. This is the one you want to nest
the new subcategory
under.
- Click the folder icon on the category's right.
- Fill out the subcategory's
details.
- Click Add category.
π‘ You can also create
subcategories via
the Add
Category option β select a parent
category in
the Nest Category Under field.
Edit an
existing category
- Switch to
the Help Docs
site's Categories tab.
- Scroll to the relevant category.
- Click the pencil icon on the category's right.
- Update the category's details.
- Click Edit category to
save your changes.
Delete a
category
β οΈ Categories
and subcategories cannot be
deleted while they still contain
articles. You must first delete those
articles or move them to another
category).
β οΈ Parent categories
cannot
be deleted while
they still contain subcategories.
You
must first delete the
subcategories or move them to
another
location in your category
structure.
- Switch to
the Help Docs
site's Categories tab.
- Scroll to the relevant category.
- Click the trash can icon on the category's right.
- Click Delete to confirm.
Reorder
categories
You can reorder a Help Docs
site's categories to customize how they
appear on your published site.
- Switch to
the Help Docs
site's Categories tab.
- Hover over a category in the list to
reveal the drag/move icon on the
category's left.
- Next:
- Click and drag the category to a new position in the list.
- Click and drag the category over
another category. Once the parent
category is highlighted, drop the one
you're moving to make it a
subcategory.
Understanding
categories
Articles only appear in
categories to which they have been
explicitly
added.
- If you add an article to a
subcategory but do not include it in
the top
level category, the article will not
be
displayed when you view that top level
category in Teamwork Desk, or if a
customer
views that category on your published
site.
Categories are only displayed on
a Help Docs site's homepage if they:
- Have the Show on
homepage toggle
enabled.
- Contain published articles.
For more information, see: Creating
a Help Docs
Article