How to Add a New Article

Follow these steps to add a new article to the Help Center. The whole process takes about 10–15 minutes once you are comfortable with it.

---

Step 1 — Choose the Right Folder

Articles are grouped into folders that match the sidebar sections. Pick the folder that best fits your article's topic:

If your article does not fit neatly into any of these, ask the team which section makes the most sense.

---

Step 2 — Create the File

Inside the chosen folder, create a new file with the .mdx extension. Name it using lowercase letters and hyphens only — no spaces, no capital letters:

adding-a-new-product.mdx      ✓ Good
Adding a New Product.mdx      ✗ Bad (spaces and capitals)
how-to-export-reports.mdx     ✓ Good

---

Step 3 — Add the Frontmatter

At the very top of your new file, add the following block. This tells the Help Center the article's title and the short description shown in search results:

---
title: Your Article Title Here
description: A one-sentence summary of what this article covers.
---

Leave a blank line after the closing --- before you start writing your content.

---

Step 4 — Write Your Content

Write the article body below the frontmatter using Markdown. A few pointers:

• Start with a brief one or two sentence intro explaining what this article is about.
• Use ## headings to break the article into clear sections.
• Use numbered lists for step-by-step instructions.
• Use bullet lists for options or non-sequential items.
• Keep sentences short and direct — write for someone who may be unfamiliar with the system.

See Markdown Basics for a full formatting reference.

---

Step 5 — Register the Article in meta.json

Each folder has a meta.json file that controls the order articles appear in the sidebar. You need to add your article's filename (without the .mdx extension) to the pages list.

Open the meta.json file inside your folder. It will look something like this:

{
  "title": "Inventory",
  "pages": [
    "adding-a-product",
    "managing-stock",
    "stock-adjustments"
  ]
}

Add your filename in the position where you want it to appear. For example, to add it second:

{
  "title": "Inventory",
  "pages": [
    "adding-a-product",
    "your-new-article-name",
    "managing-stock",
    "stock-adjustments"
  ]
}

---

Step 6 — Submit Your Changes

Once your article is written and registered:

• If you use Git: Commit your changes and open a pull request for review.
• If you are not comfortable with Git: Share your .mdx file with a developer and they will add it for you.

A developer will review the article, check the formatting, and publish it to the live Help Center.

---

Need Help?

If you get stuck at any step, reach out to the development team. We are happy to review a draft, help you set up your file, or answer questions about formatting and structure.