
وثائق SREREALDB ، بنيت باستخدام ASTRO.
إذا كنت ترغب في المساهمة ، فيرجى قراءة الإرشادات المساهمة.
![]()
![]()
![]()
![]()
![]()
![]()
![]()
![]()
تفضل بزيارة SREEREALDB.com/docs للبدء في SREREALDB.
يرجى الاطلاع على إرشاداتنا المساهمة.
لدينا قائمة بالمشكلات الأولى الجيدة التي تحتوي على الأخطاء التي لها نطاق محدود نسبيًا. هذا مكان رائع للبدء ، واكتساب الخبرة ، والتعرف على عملية المساهمة لدينا.
للبدء في المساهمة في وثائق SurrealDB ، قم أولاً بتثبيت الحزم المطلوبة باستخدام الأمر التالي.
يستخدم هذا المشروع BUN كمدير حزمة لدينا. إذا لم تقم بتثبيت BUN بعد ، فيرجى الاطلاع على دليل التثبيت لنظام التشغيل الخاص بك. كما يتطلب node.js v20.0.0 أو أعلى.
bun i يبدأ الأمر التالي خادم تطوير محلي ويفتح نافذة المتصفح. تنعكس معظم التغييرات مباشرة دون الحاجة إلى إعادة تشغيل الخادم.
bun dev
يقوم الأمر التالي بإنشاء وإنشاء محتوى ثابت في دليل build ، ويمكن بعد ذلك تقديمه باستخدام أي خدمة استضافة محتويات ثابتة.
bun run build
للمساهمة في الوثائق ، سيتم إجراء معظم التغييرات الخاصة بك على دليل src/content . كل قسم من الوثائق له دليل فرعي خاص به ، وكل صفحة عبارة عن ملف MDX.
src/
assets/
components/
content/
doc-surrealdb/
doc-surrealql/
doc-surrealist/
...
layouts/
pages/
styles/
util/ للتأكد من أن الوثائق متسقة وتتبع دليل أسلوبنا ، نستخدم make qc للتحقق من وجود أخطاء. يمكنك أيضًا استخدام make qa لإصلاح معظم الأخطاء تلقائيًا.
فيما يلي الأوامر لبعض الأوامر المشتركة التي قد تحتاجها إلى استخدامها.
make install - تثبيت التبعيات ، لأول مرة أو عند تغييرهاmake dev - قم بتشغيل خادم تطويرmake build - بناء الموقعmake preview - معاينة بناء قمت بإنشائهاmake qc - تحقق من جودة رمز (FMT + LINT)make qa - تطبيق اقتراحات جودة الرمز الآمنmake qau - تطبيق اقتراحات جودة الرمز الآمن (UN)