Projectstructuur

#Projectstructuur

De CLI beheert helpcentruminhoud als een directory van Markdown-bestanden, georganiseerd per categorie.

#Configuratie

Het opencx.json bestand in de hoofdmap van het project configureert de CLI:

{
  "help_center_id": "hc_abc123",
  "content_dir": "docs",
  "api_url": "https://api.opencx.co",
  "dashboard_url": "https://app.opencx.co",
  "provider": "cloud"
}

content_dir wijst naar de hoofdmap waar alle inhoud zich bevindt.

#Directory-indeling

docs/
  getting-started/
    quickstart.md
    installation.md
  billing/
    plans-and-pricing.md
    invoices.md

• Elke subdirectory is een categorie. De naam van de directory is de categorie-slug.
• Categorieweergavenamen (en optionele beschrijving, pictogram) worden ingesteld in opencx.json onder categories (zie Categorie metadata).
• Elk *.md bestand is een artikel. De bestandsnaam (zonder extensie) is de artikel-slug.

#Slugs

Alle directory- en bestandsnamen moeten geldige slugs zijn: alleen kleine alfanumerieke tekens en koppeltekens, volgens het patroon ^[a-z0-9]+(?:-[a-z0-9]+)*$.

Geldig: getting-started, billing, plans-and-pricing Ongeldig: Getting Started, billing_info, --leading-hyphen

#Artikelformaat

Artikelen zijn Markdown-bestanden met YAML-frontmatter. Het title veld is verplicht:

---
title: Quickstart
description: Binnen enkele minuten aan de slag.
meta_title: OpenCX Quickstart Gids
meta_description: Leer hoe je OpenCX snel instelt.
---

Je artikelinhoud hier.