Skip to main content

docs/ — Help articles

English source content. Translations are generated automatically — never edit i18n/.

Layout

  • docs/<topic_id>/<article_id>.md — one article (numeric ids match the app's article ids; must be unique).
  • docs/<topic_id>/_category_.json — category label / position.
  • docs/_TEMPLATE.md — copy this for new articles (ignored by the build, _-prefixed).
  • docs/intro.md — home page (slug /).

The sidebar is autogenerated from the folder tree (sidebars.js) — no nav file to edit.

Frontmatter

id: <article_id>
topic_id: <topic_id>
sidebar_position: <n> # order within the category
title: ...
description: ... # shown in search results + meta
last_update:
date: YYYY-MM-DD # set by hand (see root CLAUDE.md gotcha)
slug: "/article/<article_id>"
youtube_video_id: "" # optional video embed
tags: ["...", "..."]

File-suffix variants (selected per build by the config)

SuffixBehaviour
_archived, _v3excluded from all builds
_v4current content (built)
_atis / _brandedonly in the webapp / branded builds
_partneronly in the partner build

Images

static/articles/<article_id>/<name>.webpWebP only. Reference with an absolute path: ![alt](/articles/<id>/x.webp).

See CONTRIBUTING.md for the authoring walkthrough and context.md for translation terminology rules.