Skip to content
HelpWell

Write and publish a help article

2 min read Updated October 16, 2026

Open Knowledge base, start a new article, fill in a title and collection, set the status to published and save. The article is then in your help center.

  1. #Open the editor for a new article

    Go to Knowledge base in the navigation and start a new article. The editor opens with empty fields.

  2. #Give it a title

    Every article needs a title. If you leave it empty, you see: "An article needs a title."

    You can also add a short description.

  3. #Pick a collection

    A new article needs a collection. Pick an existing one, or type a new name. If you type the title of a collection that already exists, the article goes into that collection. Otherwise a new collection is created from the name. If you leave it empty, you see: "Pick a collection, or name a new one."

    You set the collection when you create the article. After that, the article stays in its collection.

  4. #Write the article

    Write the body in Markdown. The preview shows the article as readers will see it, and it updates as you type. You can upload images in the editor.

    The help center supports these Markdown blocks:

    • Callouts, written in GitHub alert syntax, such as [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] and [!CAUTION].
    • Numbered steps.
    • Tabs.
    • Collapsible sections.
    • Video embeds from YouTube, Vimeo, Loom or Wistia.
    • Tables.

  5. #Set the status to published

    Pick a status from the list. A new article starts as a draft. Set it to published to make it a live article. If you leave the status invalid, you see: "Pick a status from the list."

  6. #Select Save

    Select Save. HelpWell saves the article and opens it. The article is re-indexed only after the save succeeds.

Important

A published article can't have an empty body. HelpWell checks this when you select Save, and it shows an error until you add content. A draft can be empty.

#If Save doesn't write the article

On an install that has no way to write articles, Save doesn't write anything. It gives you the article as a file, with the path it belongs at, so you can add it to your content yourself. This applies to installs you run yourself, not to products HelpWell hosts.

If the save fails, the editor stays open with your changes and shows the reason.

Was this article helpful?

Related