هيكل المشروع

#هيكل المشروع

يدير CLI محتوى مركز المساعدة كدليل من ملفات Markdown، منظمة حسب الفئة.

#التكوين

يقوم ملف opencx.json في جذر المشروع بتكوين 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 إلى الدليل الجذري حيث يوجد جميع المحتوى.

#تخطيط الدليل

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

• كل دليل فرعي هو فئة. اسم الدليل هو رمز الفئة.
• يتم تعيين أسماء عرض الفئة (ووصف اختياري، رمز) في opencx.json تحت categories (انظر بيانات وصف الفئة).
• كل ملف *.md هو مقال. اسم الملف (بدون الامتداد) هو رمز المقالة.

#الرموز

يجب أن تكون جميع أسماء الدليل والملفات صالحة كرموز: أحرف أبجدية رقمية صغيرة وشرطات فقط، مطابقة للنمط ^[a-z0-9]+(?:-[a-z0-9]+)*$.

صالح: getting-started, billing, plans-and-pricing غير صالح: Getting Started, billing_info, --leading-hyphen

#تنسيق المقالة

المقالات هي ملفات Markdown مع YAML frontmatter. حقل title مطلوب:

---
title: Quickstart
description: Get up and running in minutes.
meta_title: OpenCX Quickstart Guide
meta_description: Learn how to set up OpenCX quickly.
---

Your article content here.