Skip to main content
Help center

Help center

How help articles are written

The template every new help-center article follows — one folder, three languages, no code.

A help article is a folder under content/help/<slug>/ with three files: en.mdx, fr.mdx and es.mdx. Each file starts with a short YAML header (title, excerpt, category) followed by plain Markdown.

What you can use#

  • Headings from ## down (the title is rendered for you — never add a # line).
  • Lists, bold, italics, links to other help articles like Billing & plans or to the app like your event types.
  • Screenshots placed under public/screenshots/help/, referenced as ![alt text](/screenshots/help/file.png) and lighter than 300 KB.
  • Tables and code blocks — GitHub-flavoured Markdown.

What is rejected before publishing#

The pipeline refuses an article that is missing a language, has a header field out of range, embeds raw HTML or scripts, links to a page that does not exist, or ships an oversized image. A refused article never reaches the site — it simply stays on its branch until fixed.

How help articles are written — Help center · Caledee