رفتن به محتوا

ساختار مستندات

مسیر نقش
src/content/docs/fa, src/content/docs/en محتوای دوزبانهٔ عمومی
src/styles/custom.css تایپوگرافی، RTL/LTR، و قواعد نمایش
docs/adr/ تصمیم‌های معماری
docs/architecture/ مدل مالکیت، قرارداد منبع، بومی‌سازی، طراحی دیپلوی
contracts/ محل تعریف قراردادهای داخلی انتشار/ادغام (بدون پیاده‌سازی همگام‌سازی در این فاز)
scripts/validation/ بررسی‌های ساخت، لینک، i18n، و جست‌وجو
.gitlab-ci.yml اعتبارسنجی CI
  • مخزن‌های سرویس: منبع معتبر قراردادها، Schema/CRD، معماری داخلی، و مثال‌های آزموده‌شدهٔ سرویس.
  • aidin-docs: تجربهٔ مستندات عمومی، راهنماهای مشتری، آموزش‌های بین‌سرویسی، ناوبری دوزبانه، و ارائهٔ مرجع عمومی.
  • aidin-landing: پیام بازاریابی، کشف محصول، و پیوند به مستندات.

قراردادهای آینده باید از artifactهای تغییرناپذیر و تأییدشده (commit/release پین‌شده) مصرف شوند؛ fetch تصادفی از شاخهٔ پیش‌فرض در build تولید مجاز نیست.