Knowledgebase

The knowledgebase is a help centre built into the store: FAQ, how-to guides, delivery and returns information, product manuals. It has a tree of categories, articles with rich content, search, related articles and optional comments. The documentation you are reading now is built with it.

Manage the knowledgebase

Content → Knowledgebase shows categories and articles in one tree with their type, whether they are published and their display order.

Manage knowledgebase: the categories Orders & Shipping, Returns and Rentals & Auctions with Create knowledgebase category and Create article buttons
Content → Knowledgebase.

Add a category

Click Create knowledgebase category. Enter the Name, a Description shown on the category page, a Parent category for a sub-category, the Display order, Published, and the SEO fields.

Add an article

  1. Click Create article.
  2. Enter the Title and the Content in the HTML editor. Use headings, lists and pictures - long articles read better in sections.
  3. Choose the Parent category, set Display order and Published.
  4. Tick Show on homepage to list the article on the knowledgebase start page, and Allow comments if readers may ask questions under it.
  5. On Related articles, link articles to show under it. Save.
Editing the article How long does delivery take: title, content editor, parent category Orders & Shipping, display order, published and allow comments
The article editor.

On the storefront

The knowledgebase is at /knowledgebase: a search box, the category tree, a text block you can edit (the page block KnowledgebaseHomePage) and the articles marked Show on homepage. Every category and article has its own address.

The storefront Knowledgebase page with categories in the sidebar, a search box and homepage articles
The knowledgebase on the storefront (Nordic theme).

Settings

Settings → Content settings, tab Knowledgebase: Enabled (off by default - turn it on first), Allow not registered users to leave comments and Notify about new article comments.

Tips

  • Link help articles from product pages, the checkout and e-mails; a good article answers the question before it becomes a support ticket.
  • Unpublished articles can be previewed by staff with the knowledgebase permission, so you can review before publishing.

Question not answered here? Ask the community on GitHub Discussions ↗