Modifikasi Kode Otomatis
doQumentation secara otomatis menerapkan sejumlah kecil modifikasi pada konten tutorial dan panduan Qiskit dari upstream untuk memastikan pengalaman yang lancar dan interaktif. Halaman ini mendokumentasikan setiap modifikasi sehingga kamu bisa memahami dengan tepat apa yang berubah dibandingkan dokumentasi IBM Quantum aslinya.
Salinan notebook (Buka di Colab / Binder / Code Engine)
Saat kamu mengklik Open in Colab, Open in JupyterLab, atau Open in Code Engine, kamu akan menerima salinan notebook asli dengan tambahan berikut:
1. Sel notifikasi setup (markdown)
Sel blockquote disisipkan di bagian paling atas yang menjelaskan bahwa doQumentation menambahkan sel setup otomatis. Sel ini menautkan kembali ke halaman ini.
2. Sel prasyarat (kode)
Sel kode disisipkan setelah notifikasi yang:
- Menginstal paket yang diperlukan (
qiskit,qiskit-aer,qiskit-ibm-runtime,pylatexenc, ditambah paket khusus tutorial yang terdeteksi melalui pemindaian import). Instalasi akan dilewati jika paket sudah tersedia (misalnya di Binder atau Code Engine yang sudah terinstal sebelumnya). - Menyediakan template kredensial yang dikomentari untuk IBM Quantum, sehingga pengguna yang ingin menjalankan di hardware nyata bisa menghapus komentar dan mengisi API key mereka.
Di Google Colab, sel ini dijalankan otomatis saat notebook dibuka melalui
flag metadata cell_execution_strategy: setup.
3. Penulisan ulang path gambar
Path gambar relatif (/docs/images/..., /learning/images/...) ditulis ulang
agar berfungsi dengan benar di lingkungan notebook standalone.
Halaman MDX (rendering di browser)
Tutorial yang ditampilkan di website ini dikonversi dari notebook .ipynb atau
file .mdx dari upstream. Transformasi berikut diterapkan:
- Baris
pip installditambahkan ke blok kode Python yang mengimpor paket pihak ketiga, memungkinkan eksekusi satu klik melalui thebelab. - Bagian IBM Tutorial Survey: Catatan ditambahkan untuk menjelaskan bahwa survei tersebut milik IBM Quantum dan menautkan ke GitHub Issues doQumentation untuk umpan balik terkait situs.
- Widget umpan balik: Widget "Was this helpful?" ditambahkan di bagian bawah setiap tutorial, dilacak melalui analitik Umami yang ramah privasi.
- Perbaikan sintaks MDX: Kurung kurawal, hierarki heading, dan masalah kompatibilitas JSX diperbaiki secara otomatis untuk rendering Docusaurus.
- OpenInLabBanner: Banner interaktif disisipkan di bawah judul dengan tombol untuk membuka notebook di Colab, Binder, atau Code Engine.
Yang TIDAK dimodifikasi
- Konten tutorial itu sendiri (penjelasan, logika kode, output) tidak pernah diubah.
- Atribusi penulis asli dipertahankan melalui frontmatter dan file NOTICE (lisensi Apache 2.0 / CC BY-SA 4.0).
- Tidak ada kode telemetri atau pelacakan yang disisipkan ke dalam notebook. Analitik (Umami) hanya berjalan di website doQumentation, tidak di notebook yang diekspor.
Kode sumber
Semua transformasi diimplementasikan di
scripts/sync-content.py.