starknet docs

مستودع توثيق Starknet

موقع STARKNET DOCS ، https://docs.starknet.io ، مكتوبة في ASCIIDOC وهو مصمم باستخدام Antora ، مولد موقع ثابت لـ ASCIIDOC.

المساهمة في وثائق StarkNet

إذا كنت مهتمًا بالمساهمة في الوثائق الفنية StarkNet ، فإن الجدول التالي يوفر روابط سريعة لمساعدتك في البدء.

سؤال	الموارد
أنا مهتم ، كيف أساهم؟	للحصول على معلومات حول كيفية المساهمة ، راجع طرق مختلفة للمساهمة.
هل هناك أي إرشادات أساسية لمساعدتي؟	للحصول على الإرشادات الأساسية لمساعدتنا في الحفاظ على محتوىنا ثابتًا ، راجع إرشادات الوثائق.
هل هناك دليل نمط ودليل كتابة يجب أن أستخدمه؟	انظر دليل StarkNet Documentation النمط التكميلي.
كيف أقوم بإعداد محطة العمل الخاصة بي؟	انظر إعداد بيئتك.

طرق مختلفة للمساهمة

هناك بعض الطرق المختلفة التي يمكنك من خلالها المساهمة في وثائق StarkNet:

• إنشاء قضية github.

• إرسال طلب سحب (PR). يمكنك إنشاء استنساخ محلي لشوكة مستودع StarkNet-Docs ، وإجراء تغييراتك ، وتقديم العلاقات العامة. يكون هذا الخيار هو الأفضل إذا كان لديك تغييرات كبيرة ، أو لمساعدة التغييرات التي تريد إضافتها بسرعة أكبر.

ماذا يحدث عند تقديم العلاقات العامة؟

عند إرسال العلاقات العامة ، يقوم فريق StarkNet Docs بمراجعة العلاقات العامة وترتب المزيد من المراجعات الفنية حسب الضرورة. إذا كانت العلاقات العامة تتطلب تغييرات ، فإن المراجعين يضيفون تعليقات إلى العلاقات العامة. قد نطلب منك إجراء التغييرات ، أو نعلمك أننا قمنا بدمج المحتوى الخاص بك في العلاقات العامة المختلفة. في بعض الأحيان ، قد نضيف ارتباطًا إلى العلاقات العامة الأصلية مباشرة. عند مراجعة العلاقات العامة وإكمال جميع التحديثات ، يقوم فريق الوثائق بدمج العلاقات العامة ويطبقه على الإصدار (الإصدار) الصحيح.

نصائح حول التأليف

• دليل StarkNet Documentation Guide التكميلي: إرشادات النمط العام وتوجيه الكتابة.

للحصول على معلومات حول الكتابة في Asciidoc ، انظر:

• وثائق اللغة ASCIIDOC

• ASCIIDOC SYNTAX مرجع سريع

ملحوظة

هناك طرق متعددة لمعرفات الترميز ، وكتل التعليمات البرمجية ، والمراجع المتقاطعة ، والروابط. بشكل عام ، نستخدم اتفاقيات الترميز الأكثر وضوحًا للترميز من أجل تحديد أولويات قابلية قراءة التعليمات البرمجية. يتم سرد معظم اتفاقيات الترميز هذه في ASCIIDOC Mark-Up مرجع سريع لوثائق Red Hat

قبل أن تبدأ

1. قم بتثبيت yarn إذا لم يتم تثبيته بالفعل.

2. تثبيت npx إذا لم يتم تثبيته بالفعل.

3. استنساخ هذا الريبو ، إما من شوكة ، أو إذا كنت متعاونًا رسميًا ، ثم مباشرة من starknet-io/starknet-docs .

4. تغيير إلى دليل starknet-docs .

5. قم بتشغيل أمر yarn لإعداد البيئة:

    غزل

يجب أن يقوم yarn بإعداد بيئتك عن طريق تثبيت الوحدات النمطية المطلوبة بناءً على package-lock.json و package.json . إذا كان ناجحًا ، فيجب أن تكون قادرًا على إنشاء المحتوى ومعاينةه.

بناء المحتوى ومعاينته محليًا

بعد الكتابة أو تحرير المحتوى ، لمعاينة التغييرات الخاصة بك:

1. قم ببناء المحتوى عن طريق تشغيل برنامج build_local_site.sh Build Script:

   ./build_local_site.sh

   يقوم هذا الأمر بإنشاء موقع الويب في Directory public_html .

2. افتح موقع الويب عن طريق القيام بواحد مما يلي:

   • افتح صفحة البدء: <repo_root>/public_html/index.html .

   • قم بتشغيل خادم HTTP المعبأ مع antora:

     npx http-server public_html -c-1

     يعمل الخادم ، ويمنحك عناوين URL أو أكثر من عناوين URL المحلية التي يمكنك استخدامها لعرض موقع الويب. على سبيل المثال:

     Starting up http-server, serving public_html
     
     ...
     
     Available on:
       http://127.0.0.1:8080
       http://192.168.68.111:8080
       http://192.168.14.3:8080
       http://10.14.0.2:8080
     Hit CTRL-C to stop the server

إصدار مستندات StarkNet على Github (للمسلولين فقط)

العملية عالية المستوى لإطلاق تغييرات الوثائق في هذا المستودع.

أثناء تطوير المحتوى ، يقوم الكتاب بدمج الفروع مع التغييرات إما مباشرة في main ، إلى فرع ثانوي حسب الحاجة ، حيث تنتظر هذه التغييرات حتى نكون مستعدين لإطلاقها - أي نشرها على docs.starknet.io.

تقوم إجراءات GitHub بإنشاء علامات وإصدارات GIT التي تظهر في صفحات الإصدارات وعلامات REPO.

عندما يتم دمج فرع الميزة في الفرع main ، يقوم إجراء GitHub بإنشاء علامة إصدار في التنسيق v<version>.<major_update>.<minor_update> وتحديث CHANGELOG.md . ثم ينشر المحتوى الجديد إلى docs.starknet.io.

إجراء

دمج فرع الميزات إلى main ينشر التغييرات تلقائيًا في فرع الميزات. لا توجد خطوات إضافية مطلوبة.

Github يزيد أرقام الإصدار في package.json و package-lock.json ، ويقوم بتحديث CHANGELOG.md مع أوصاف كل علاقات عامة تم دمجها للتو في main . . قم بتحديث الفرع main المحلي من الفرع main البعيد باستخدام أحد ما يلي:

• سحب التغييرات:

  starknet-docs (main) git pull

• قم بعمل Rebase من [email protected]:starknet-io/starknet-docs.git :

  starknet-docs (main) git fetch origin
  starknet-docs (main) git rebase origin/main

  ملحوظة

  إذا كنت تستخدم شوكة ، فإن ريبو الشوكة الخاص بك هو origin افتراضيًا ، في هذه الحالة ، يجب عليك تعيين الاسم upstream إلى [email protected]:starknet-io/starknet-docs.git . لذلك عند إعادة الصياغة ، استخدم upstream بدلاً من origin في الأوامر المذكورة أعلاه.