Pengubahsuaian Kod Automatik

doQumentation secara automatik menerapkan beberapa pengubahsuaian kecil pada kandungan tutorial dan panduan Qiskit dari sumber asal untuk memastikan pengalaman yang lancar dan interaktif. Halaman ini mendokumentasikan setiap pengubahsuaian supaya anda dapat memahami dengan tepat apa yang berubah berbanding dokumentasi IBM Quantum yang asal.

Salinan notebook (Buka dalam Colab / Binder / Code Engine)

Apabila anda klik Open in Colab, Open in JupyterLab, atau Open in Code Engine, anda akan menerima salinan notebook asal dengan tambahan berikut:

1. Sel notis persediaan (markdown)

Sel blockquote disisipkan di bahagian paling atas yang menerangkan bahawa doQumentation telah menambah sel persediaan automatik. Ia menghubungkan semula ke halaman ini.

2. Sel prasyarat (kod)

Sel kod disisipkan selepas notis yang:

• Memasang pakej yang diperlukan (qiskit, qiskit-aer, qiskit-ibm-runtime, pylatexenc, ditambah mana-mana pakej khusus tutorial yang dikesan melalui pengimbasan import). Pemasangan dilangkau jika pakej sudah ada (cth. pada Binder atau Code Engine di mana ia telah dipasang terlebih dahulu).
• Menyediakan templat kelayakan yang dikomentari untuk IBM Quantum, supaya pengguna yang ingin menjalankan pada perkakasan sebenar boleh membuka komen dan mengisi kunci API mereka.

Pada Google Colab, sel ini dijalankan secara automatik semasa notebook dibuka melalui bendera metadata cell_execution_strategy: setup.

3. Penulisan semula laluan imej

Laluan imej relatif (/docs/images/..., /learning/images/...) ditulis semula supaya berfungsi dengan betul dalam persekitaran notebook berdiri sendiri.

Halaman MDX (rendering dalam pelayar)

Tutorial yang dipaparkan di laman web ini ditukar dari notebook .ipynb atau fail .mdx dari sumber asal. Transformasi berikut digunakan:

• Baris pip install ditambah pada blok kod Python yang mengimport pakej pihak ketiga, membolehkan pelaksanaan satu klik melalui thebelab.
• Bahagian Tinjauan Tutorial IBM: Nota ditambahkan yang menjelaskan bahawa tinjauan tersebut adalah milik IBM Quantum dan menghubungkan ke GitHub Issues doQumentation untuk maklum balas khusus laman web.
• Widget maklum balas: Widget "Adakah ini membantu?" ditambahkan di bahagian bawah setiap tutorial, dijejak melalui analitik Umami yang mesra privasi.
• Pembetulan sintaks MDX: Pendakap kerinting, hierarki tajuk, dan isu keserasian JSX diperbetulkan secara automatik untuk rendering Docusaurus.
• OpenInLabBanner: Banner interaktif disisipkan di bawah tajuk dengan butang untuk membuka notebook dalam Colab, Binder, atau Code Engine.

Apa yang TIDAK diubah

• Kandungan tutorial itu sendiri (penjelasan, logik kod, output) tidak pernah diubah.
• Atribusi pengarang asal dikekalkan melalui frontmatter dan fail NOTICE (lesen Apache 2.0 / CC BY-SA 4.0).
• Tiada kod telemetri atau penjejakan disisipkan ke dalam notebook. Analitik (Umami) hanya berjalan di laman web doQumentation, bukan dalam notebook yang dieksport.

Kod sumber

Semua transformasi dilaksanakan dalam scripts/sync-content.py.