Category Metadata

Category metadata (name, description, icon) lives in opencx.json under the optional categories key. Each key is the category path relative to content_dir (e.g. getting-started, advanced/configuration). The value is an object with name (required), and optional description and icon.

#Format

In opencx.json:

{
  "categories": {
    "getting-started": { "name": "Getting Started" },
    "billing": {
      "name": "Billing & Payments",
      "description": "Invoices, subscriptions, and payment methods",
      "icon": "credit-card"
    }
  }
}

#Fields (per category)

#Fallback

When a category path is not listed in categories, the display name is derived from the directory name: split on hyphens and capitalize each word.

#Updating categories

Running opencx content pull updates categories in opencx.json from the remote help center. You can also edit opencx.json by hand.