التعديلات التلقائية على الكود
تُطبِّق doQumentation تلقائيًا عددًا محدودًا من التعديلات على محتوى دروس Qiskit التعليمية وأدلته المستمدة من المصادر الأصلية، وذلك لضمان تجربة تفاعلية سلسة. توثّق هذه الصفحة كل تعديل حتى تتمكن من فهم ما تغيّر بدقة مقارنةً بتوثيق IBM Quantum الأصلي.
نسخ دفاتر الملاحظات (فتح في Colab / Binder / Code Engine)
عند النقر على Open in Colab أو Open in JupyterLab أو Open in Code Engine، تحصل على نسخة من دفتر الملاحظات الأصلي مع الإضافات التالية:
1. خلية إشعار الإعداد (Markdown)
تُدرج خلية اقتباس في أعلى الدفتر تشرح أن doQumentation أضافت خلية إعداد تلقائية، مع رابط يعود إلى هذه الصفحة.
2. خلية المتطلبات الأساسية (كود)
تُدرج خلية كود بعد الإشعار تقوم بما يلي:
- تثبيت الحزم المطلوبة (
qiskit،qiskit-aer،qiskit-ibm-runtime،pylatexenc، إضافةً إلى أي حزم خاصة بالدرس يتم رصدها عبر فحص الاستيراد). يُتجاوَز التثبيت إذا كانت الحزم موجودة مسبقًا (مثلًا على Binder أو Code Engine حيث تكون مثبّتة مسبقًا). - توفير قالب بيانات اعتماد معلّق لـ IBM Quantum، حتى يتمكن المستخدمون الراغبون في التشغيل على أجهزة حقيقية من إلغاء التعليق وإدخال مفتاح API الخاص بهم.
على Google Colab، تُنفَّذ هذه الخلية تلقائيًا عند فتح دفتر الملاحظات عبر
علامة البيانات الوصفية cell_execution_strategy: setup.
3. إعادة كتابة مسارات الصور
تُعاد كتابة مسارات الصور النسبية (/docs/images/...، /learning/images/...)
لتعمل بصورة صحيحة في بيئات دفاتر الملاحظات المستقلة.
صفحات MDX (العرض داخل المتصفح)
تُحوَّل الدروس التعليمية المعروضة على هذا الموقع من دفاتر الملاحظات الأصلية
بصيغة .ipynb أو ملفات .mdx. تُطبَّق التحويلات التالية:
- إضافة أسطر
pip installإلى كتل كود Python التي تستورد حزم خارجية، مما يتيح التنفيذ بنقرة واحدة عبر thebelab. - قسم استطلاع IBM Tutorial: تُضاف ملاحظة توضح أن الاستطلاع يعود إلى IBM Quantum مع رابط إلى مشكلات GitHub الخاصة بـ doQumentation لتلقي الملاحظات المتعلقة بالموقع.
- أداة التغذية الراجعة: تُضاف أداة "هل كان هذا مفيدًا؟" في أسفل كل درس تعليمي، يتم تتبعها عبر تحليلات Umami الصديقة للخصوصية.
- إصلاحات بناء جملة MDX: يُصحَّح تلقائيًا الأقواس المعقوفة وتسلسل العناوين ومشكلات توافق JSX من أجل عرض Docusaurus.
- OpenInLabBanner: يُحقن شريط تفاعلي أسفل العنوان يحتوي على أزرار لفتح دفتر الملاحظات في Colab أو Binder أو Code Engine.
ما الذي لا يُعدَّل
- محتوى الدرس التعليمي نفسه (الشروح ومنطق الكود والمخرجات) لا يُغيَّر أبدًا.
- نسب المؤلف الأصلي محفوظ عبر بيانات frontmatter وملف NOTICE (رخص Apache 2.0 / CC BY-SA 4.0).
- لا يُحقن أي كود قياس أو تتبع في دفاتر الملاحظات. تعمل التحليلات (Umami) على موقع doQumentation فقط، ولا تعمل في دفاتر الملاحظات المُصدَّرة.
الكود المصدري
جميع التحويلات مُطبَّقة في
scripts/sync-content.py.