שינויי קוד אוטומטיים

doQumentation מיישמת מספר קטן של שינויים על תוכן המדריכים של Qiskit מהמקור, כדי להבטיח חוויה חלקה ואינטראקטיבית. דף זה מתעד כל שינוי כך שתוכלו להבין בדיוק מה השתנה בהשוואה לתיעוד המקורי של IBM Quantum.

עותקי Notebook (פתיחה ב-Colab / Binder / Code Engine)

כשאתם לוחצים על Open in Colab, Open in JupyterLab, או Open in Code Engine, אתם מקבלים עותק של ה-notebook המקורי עם התוספות הבאות:

1. תא הודעת הגדרה (markdown)

תא blockquote מוכנס בראש ה-notebook ומסביר ש-doQumentation הוסיפה תא הגדרה אוטומטי. הוא מקשר בחזרה לדף זה.

2. תא דרישות מוקדמות (קוד)

תא קוד מוכנס אחרי ההודעה ועושה את הדברים הבאים:

• מתקין חבילות נדרשות (qiskit, qiskit-aer, qiskit-ibm-runtime, pylatexenc, בנוסף לחבילות ספציפיות למדריך שזוהו דרך סריקת imports). ההתקנה מדולגת אם החבילות כבר קיימות (למשל ב-Binder או Code Engine שבהן הן מותקנות מראש).
• מספק תבנית credentials מוסברת בהערות ל-IBM Quantum, כדי שמשתמשים שרוצים להריץ על חומרה אמיתית יוכלו להסיר את ההערות ולהזין את מפתח ה-API שלהם.

ב-Google Colab, תא זה מופעל אוטומטית עם פתיחת ה-notebook דרך דגל המטאדאטה cell_execution_strategy: setup.

3. כתיבה מחדש של נתיבי תמונות

נתיבי תמונות יחסיים (/docs/images/..., /learning/images/...) נכתבים מחדש כדי לעבוד נכון בסביבות notebook עצמאיות.

דפי MDX (רינדור בדפדפן)

המדריכים המוצגים באתר זה מומרים מ-notebooks בפורמט .ipynb או מקבצי .mdx מהמקור. הטרנספורמציות הבאות מוחלות:

• שורות pip install מתווספות לבלוקי קוד Python שמייבאים חבילות צד שלישי, ומאפשרות הרצה בלחיצה אחת דרך thebelab.
• קטע סקר המדריכים של IBM: הערה מצורפת המבהירה שהסקר שייך ל-IBM Quantum ומקשרת ל-GitHub Issues של doQumentation לפידבק הקשור לאתר.
• ווידג'ט פידבק: ווידג'ט "האם זה עזר?" מצורף בתחתית כל מדריך, ונמדד דרך Umami analytics שמכבד פרטיות.
• תיקוני תחביר MDX: סוגריים מסולסלים, היררכיית כותרות ובעיות תאימות JSX מתוקנות אוטומטית לצורך רינדור ב-Docusaurus.
• OpenInLabBanner: באנר אינטראקטיבי מוזרק מתחת לכותרת עם כפתורים לפתיחת ה-notebook ב-Colab, Binder, או Code Engine.

מה לא משתנה

• תוכן המדריך עצמו (הסברים, לוגיקת קוד, פלטים) לעולם לא משתנה.
• קרדיט המחברים המקוריים נשמר דרך frontmatter וקובץ ה-NOTICE (רישיונות Apache 2.0 / CC BY-SA 4.0).
• אין קוד טלמטריה או מעקב שמוזרק ל-notebooks. Analytics (Umami) רץ רק על אתר doQumentation, לא ב-notebooks שיוצאו.

קוד מקור

כל הטרנספורמציות ממומשות ב- scripts/sync-content.py.