Everyone

Knowledge Base Categories

Organise knowledge base articles into categories for easier navigation.

Last updated 1776211200
  • Reordering Categories
  • Deactivating a Category
  • How Categories Display in the Portal
  • Deleting a Category
  • Overview

    Categories are the top-level groupings that appear on the /kb index page. Every article must belong to exactly one category. Creating clear, well-named categories helps clients find answers faster.

    Creating a Category

    1. Go to Admin → Content → Knowledge Base → Categories.
    2. Click Add Category.
    3. Fill in the fields described below.
    4. Click Save.

    Category Fields

    Field Required Notes
    Name Yes Displayed as the card title on /kb
    Slug Yes URL segment, e.g. billing/kb/billing
    Description No Short text shown below the name on the index card
    Icon No Icon class or identifier used in the portal theme
    Sort Order Yes Lower numbers appear first; default to increments of 10
    Active Yes Toggle off to hide the category and all its articles

    [!TIP] Use sort order increments of 10 (10, 20, 30…) rather than 1, 2, 3. This makes inserting a new category between two existing ones easy without renumbering everything.

    Reordering Categories

    To change the display order, edit each category and update its Sort Order value. Categories with the same sort order value are sorted alphabetically as a tiebreaker.

    There is no drag-and-drop reordering — update the sort_order field directly.

    Deactivating a Category

    Setting a category to Inactive immediately hides it and all articles within it from the portal. This is the correct way to temporarily remove a topic area — do not delete the category if you intend to restore it later.

    [!WARNING] Deactivating a category does not change the published/draft status of its articles. If you reactivate the category, all previously published articles become visible again instantly.

    How Categories Display in the Portal

    The /kb index renders one card per active category, in sort order. Each card shows:

    • The category name
    • The category description (if set)
    • The icon (if configured)
    • A count of published articles in that category

    Clicking a category card takes the client to /kb/{slug}, which lists all published articles in that category. Article order within a category is controlled by the sort order set on each individual article.

    Deleting a Category

    Deleting a category that still contains articles is blocked. Move or delete all articles in the category first, then delete the category.

    [!IMPORTANT] Category deletion requires password confirmation to prevent accidental removal. Enter your admin password in the confirmation modal to proceed.