Help
Internal

Example — every frontmatter field

Reference article demonstrating every field in the help center frontmatter schema, required and optional.

This article is a reference example, not user-facing content. It exists so content authors can see every supported field with a realistic value and so the build asserts that the canonical shape still validates.

What this demonstrates

  • Every required field is present with a valid value.
  • Every optional field is filled in, including the Extended (forward-compat) fields.
  • The translations map points to sibling articles in other locales.
  • searchable: false and aiRetrievable: false keep this reference out of search and agent retrieval.

How authors should use this

Copy the frontmatter block at the top of a new article and delete the fields you don't need — most articles only need the Required block plus a couple of relational fields. The Optional and Extended fields are there when you need them, not as a checklist.

See docs/FRONTMATTER.md for per-field semantics.

On this page