نشر الوثائق

تشرح هذه الصفحة كيف يتم توليد النسخة المنشورة من الوثائق انطلاقًا من المستودع.

الرابط العام

رابط الوثائق المنشورة: https://univiseditor.github.io/univis_ui/

ما هو المصدر المرجعي

مصدر الكتاب موجود داخل docs/
يعرّف docs/book.toml إعدادات mdBook
تعيش الشجرتان العربية والإنجليزية داخل docs/src/ar وdocs/src/en
يولّد mdbook build docs الموقع الثابت داخل target/book/docs

نموذج النشر

يبقى التحقق ضمن .github/workflows/docs_examples_api.yml
يتولى .github/workflows/docs_publish.yml وحده مهمة النشر
تُبنى النسخة المنشورة من نفس شجرة docs/ التي يستخدمها المساهم محليًا
الوجهة العامة المقصودة للنشر هي صفحات GitHub

مسار العمل المحلي للمساهم

mdbook build docs
mdbook serve docs -n 127.0.0.1 -p 3000

يجب أن يبقى هذا المسار المحلي هو الطريقة المرجعية لمعاينة التغييرات قبل رفعها.

ما الذي يجب التحقق منه في النسخة المنشورة

أن صفحة الوثائق الرئيسية تعمل بشكل صحيح
أن الشجرة الإنجليزية قابلة للوصول في النسخة المنشورة
أن الشجرة العربية قابلة للوصول في النسخة المنشورة
أن مبدّل اللغة يعمل بين الصفحات النظيرة
أن روابط معرض الأمثلة وصفحات الترحيل ما زالت صحيحة

صفحات مرتبطة