Overview
Articles are the individual help pages that live inside Knowledge Base categories. Each article has a title, a body, a status, and optional tags and SEO metadata. Articles can be written in Markdown or HTML.
Creating an Article
- Go to Admin → Content → Knowledge Base → Articles.
- Click Add Article.
- Fill in the required fields.
- Set the status to Published when the article is ready to go live.
- Click Save.
Article Fields
| Field | Required | Notes |
|---|---|---|
| Title | Yes | Displayed as the article heading and in search results |
| Slug | Yes | URL segment; auto-generated from title but editable |
| Category | Yes | The category this article belongs to |
| Visibility | Yes | Public or Clients-only |
| Status | Yes | Draft or Published |
| Body | Yes | Article content — Markdown or HTML supported |
| Tags | No | Comma-separated keywords, aids internal search ranking |
| Meta Description | No | 150–160 character summary for search engine snippets |
| Sort Order | No | Controls order within the category listing |
Article Statuses
| Status | Visible in Portal |
|---|---|
| Draft | No — only admins can preview it |
| Published | Yes — subject to category active status and article visibility |
Save articles as Draft while writing or reviewing them. Switch to Published only when the content is final. Unpublishing an article (switching back to Draft) removes it from the portal immediately.
Writing the Body
The body field accepts both Markdown and HTML. Use Markdown for straightforward text, lists, and code blocks. Switch to raw HTML if you need custom formatting the Markdown renderer does not support.
[!TIP] Use a short introductory paragraph that answers the core question within the first two sentences. Clients often skim and stop reading early.
Tags
Tags are plain-text keywords attached to an article. They improve the relevance of search results by adding additional terms to match against. Tags are not displayed publicly in the default portal theme.
Example tags for a billing article: invoice, payment, credit card, auto-renew
Meta Description for SEO
The meta description appears in search engine result snippets when the /kb/{category}/{slug} page is indexed. It does not affect the portal's internal search. Keep it under 160 characters and make it descriptive.
[!IMPORTANT] If no meta description is set, search engines generate their own snippet from the article body, which is usually the opening paragraph. Writing an explicit meta description gives you control over how the article appears in search results.
View Count Tracking
Commerce records a view count for each article. The count increments each time a client loads the article page. View counts are displayed in the article list in the admin panel and help identify which articles are most used or overlooked.
Articles with high view counts but also high ticket volume in the same topic area may need to be rewritten — clients are reading but not finding their answer.
Editing and Deleting Articles
- Edit — click the article title or the Edit action in the article list.
- Delete — requires password confirmation. Deleted articles are permanently removed and their URL returns 404.
[!WARNING] Deleting a published article breaks any external links to it. Consider switching the article to Draft status instead of deleting it if you are unsure whether the URL is shared anywhere.