في هذه الصفحة

أساسيات التوثيق

مرحبًا بك في نسخة اللغة العربية من دليل التوثيق. صُمِّمت هذه الصفحة كي تختبر تجربة RTL في مشروع sample-docs وتتعرف على أهم العناصر قبل البدء.

ماذا ستتعلم؟

إنشاء الصفحات: كيفية إنشاء ملف MDX جديد داخل بنية الإصدارات (/src/content/docs/v2/ar/...).
تنظيم المحتوى: استخدام الأقسام المرقّمة لضمان ظهور الصفحة في الشريط الجانبي.
إعادة استخدام المكونات: إدراج تنبيهات أو بطاقات من حزمة @docs/ui.

مبادئ التوثيق الجيد

وضوح: استخدم عناوين صريحة وأمثلة مباشرة.
اتساق: اتبع نفس الأسماء والترقيم في كل اللغات.
قابلية الصيانة: ضع الملاحظات المشتركة في مكان واحد، واعد استخدام الكتل بدل تكرارها.

خطوات سريعة للانطلاق

ثبّت الاعتمادات مرة واحدة باستخدام pnpm install.
شغّل خادم التطوير للمشروع فقط:

pnpm --filter=sample-docs dev

بعد إضافة أو إعادة تسمية ملفات التوثيق، أعد بناء بيانات الشريط الجانبي:

pnpm build:sidebar

ما التالي؟

اكتب صفحة ثانية داخل 01-guide أو أنشئ قسمًا جديدًا مثل 02-concepts.
جرّب فتح الرابط /docs/sample-docs/v2/ar/01-guide/01-getting-started للتأكد من أن الاتجاه RTL يعمل كما هو متوقع.
أضف ترجمات للعناوين في project.config.jsonc كي يظهر اسم القسم باللغة العربية داخل القوائم.

بمجرد إتمام هذه الخطوات، ستكون جاهزًا لتوسيع المحتوى العربي أو إضافة لغات RTL أخرى بسهولة.