opencx.toml
Project-level configuration. Created by opencx content init.
# Content provider (default: "help-center")
provider = "help-center"
# Your help center ID (set during auth login or manually)
help_center_id = "your-help-center-uuid"
# Directory containing your content files
content_dir = "docs"
# API URL (default: https://api.open.cx)
api_url = "https://api.open.cx"
# Dashboard URL for browser auth flow (optional)
dashboard_url = "https://platform.open.cx"
category.toml
Per-topic metadata. Place in each topic directory. Optional — if omitted, the topic name is derived from the directory name (e.g., getting-started → Getting Started).
name = "Getting Started"
description = "Learn the basics of our product"
icon = "rocket"
| Field | Required | Description |
|---|
name | No | Display name (defaults to slug → title case) |
description | No | Topic description |
icon | No | Icon identifier |
Article frontmatter
YAML frontmatter at the top of each .md file.
---
title: Welcome to OpenCX
meta_title: Welcome | OpenCX Help Center
meta_description: Get started with OpenCX in minutes
---
| Field | Required | Description |
|---|
title | Yes | Article title |
description | No | Article description |
meta_title | No | SEO title (falls back to title) |
meta_description | No | SEO description (max 160 characters) |
welcome.md → welcome.
Lock file
opencx-content-lock.json tracks sync state between local and remote content.
Commit this file to version control. Do not edit it manually — it is managed by the CLI.
| Field | Description |
|---|
last_pull_at | ISO timestamp of last pull |
last_push_at | ISO timestamp of last push |
content_hash | SHA-256 hash of canonical content |
entries | Per-file hashes for change detection |
Directory structure
Example of a complete project:
my-help-center/
├── opencx.toml
├── opencx-content-lock.json
└── docs/
├── getting-started/
│ ├── category.toml
│ ├── welcome.md
│ └── quick-start.md
├── billing/
│ ├── category.toml
│ ├── plans.md
│ └── invoices.md
└── troubleshooting/
├── category.toml
└── common-issues.md
