Create and organize Help Center articles

The Help center page is where you write the guides your customers read inside the Releaseo widget. Articles live in folders, and the folder decides where customers find each article.

You need the help center management permission to create or change anything. Without it you can still look around.

Create your first folder

The New article button stays disabled until at least one folder exists, so start there.

1. Open Help center in the dashboard.

2. On an empty page, select Create folder. Later, use the Add folder button above the Folders list.

3. Fill in the dialog:

   • Parent: choose Root folder, or an existing folder to nest the new one inside it.

   • Folder title, for example "Getting Started".

   • Description: a short line about what the folder contains.

   • Color.

   • Active in widget: switch it off to keep the folder out of the widget.

4. Save the folder.

Use the actions menu next to a folder to edit or delete it. A folder can only be deleted when it has no child folders and no articles. Delete or move those first.

Write an article

1. Select New article, then Write article.

2. Pick the Folder.

3. Enter a Title that uses the words a customer would search for, and a short Summary. The summary shows in lists and search results.

4. Write the Article body. Type / to insert a template. The templates are Getting started, Troubleshooting, API guide, FAQ and Best practices.

5. Choose a Status: Draft, Published or Archived.

6. Select Save article. When you reopen an article to change it, the button reads Update article.

Keep an article as a draft while you work on it. Customers only see it once it is published.

Feature an article

Switch on Featured article in the editor to highlight it.

Link related content

Under Curated help journeys, select Add journey to connect the article to other content. For each journey, choose a Target:

• External URL

• Changelog post

• Roadmap item

• Feature request

Give it a Label, such as "Read the release notes", then enter the URL or pick the item. Up to four journeys can be attached to one article, and up to four appear in the widget.

Import Markdown

If your docs already exist as Markdown files:

1. Select New article, then Import Markdown.

2. Choose the Folder.

3. Select Upload .md to load a file, or paste text into Markdown source. You can set the File name.

4. Select Preview to see the rendered article. A Needs refresh badge appears if you edit the source after previewing.

5. Switch on Publish after import if the article should go live straight away.

6. Select Create article.

Releaseo reads three optional lines at the top of the file, between --- markers:

---
title: Install the widget
description: Add Releaseo to your site.
slug: install-the-widget
---

Without front matter, the title comes from the first # heading, then from the file name. The summary is taken from the first line of text, and the slug is built from the title.

Find and review articles

The page header shows how many articles you have, how many are published, total views, and how many need review. Use Search articles and docs and the status filter (All statuses, Draft, Published, Archived) to narrow the table.

The table has these columns: Article, Status, Folder, Views, Helpful, Journeys, Updated and Actions. Row actions let you edit, Publish or Unpublish, or delete an article. Deleting asks for confirmation.

A Popular list in the folder sidebar shows your most-read articles.

How customer feedback works

At the bottom of each article in the widget, customers see Was this helpful? with three options: Needs work, Okay and Great. Their answers feed the Helpful percentage in your table. An article is flagged for review, with the percentage in red, when it has several negative reactions and a low helpful rate.

Translate an article

When you edit a saved article, language tabs appear in the editor so you can translate it. See "Translate your content into other languages".