Automatische Code-Änderungen

doQumentation wendet automatisch eine kleine Anzahl von Änderungen an den Upstream-Inhalten von Qiskit-Tutorials und -Anleitungen an, um ein reibungsloses, interaktives Erlebnis zu gewährleisten. Diese Seite dokumentiert jede Änderung, damit du genau nachvollziehen kannst, was im Vergleich zur ursprünglichen IBM Quantum-Dokumentation verändert wurde.

Notebook-Kopien (In Colab / Binder / Code Engine öffnen)

Wenn du auf In Colab öffnen, In JupyterLab öffnen oder In Code Engine öffnen klickst, erhältst du eine Kopie des ursprünglichen Notebooks mit diesen Ergänzungen:

1. Setup-Hinweiszelle (Markdown)

Eine Blockquote-Zelle wird ganz oben eingefügt und erklärt, dass doQumentation eine automatische Setup-Zelle hinzugefügt hat. Sie verlinkt zurück auf diese Seite.

2. Voraussetzungszelle (Code)

Eine Code-Zelle wird nach dem Hinweis eingefügt, die:

• Erforderliche Pakete installiert (qiskit, qiskit-aer, qiskit-ibm-runtime, pylatexenc sowie alle tutorial-spezifischen Pakete, die per Import-Scanning erkannt wurden). Die Installation wird übersprungen, wenn die Pakete bereits vorhanden sind (z. B. auf Binder oder Code Engine, wo sie vorinstalliert sind).

• Eine auskommentierte Anmeldedaten-Vorlage für IBM Quantum bereitstellt, damit Nutzer, die auf echter Hardware rechnen möchten, die Vorlage einkommentieren und ihren API-Schlüssel eintragen können.

In Google Colab wird diese Zelle über das Metadaten-Flag cell_execution_strategy: setup beim Öffnen des Notebooks automatisch ausgeführt.

3. Bild-Pfad-Umschreibungen

Relative Bildpfade (/docs/images/..., /learning/images/...) werden umgeschrieben, damit sie in eigenständigen Notebook-Umgebungen korrekt funktionieren.

MDX-Seiten (Browser-Rendering)

Die auf dieser Website angezeigten Tutorials werden aus Upstream-.ipynb-Notebooks oder .mdx-Dateien konvertiert. Die folgenden Transformationen werden angewendet:

• pip install-Zeilen werden zu Python-Code-Blöcken hinzugefügt, die Drittanbieter-Pakete importieren, um eine Ein-Klick-Ausführung über thebelab zu ermöglichen.

• IBM Tutorial Survey-Abschnitt: Eine Notiz wird angehängt, die klarstellt, dass die Umfrage zu IBM Quantum gehört, und die auf doQumentations GitHub Issues für seitenspezifisches Feedback verlinkt.

• Feedback-Widget: Ein „War das hilfreich?"-Widget wird am Ende jedes Tutorials eingefügt und über das datenschutzfreundliche Umami-Analytics verfolgt.

• MDX-Syntaxkorrekturen: Geschweifte Klammern, Überschriftenhierarchie und JSX-Kompatibilitätsprobleme werden automatisch für das Docusaurus-Rendering korrigiert.

• OpenInLabBanner: Ein interaktives Banner wird unterhalb des Titels eingefügt, mit Schaltflächen zum Öffnen des Notebooks in Colab, Binder oder Code Engine.

Was NICHT geändert wird

• Der Tutorial-Inhalt selbst (Erklärungen, Code-Logik, Ausgaben) wird niemals verändert.

• Die Nennung der ursprünglichen Autoren wird über Frontmatter und die NOTICE-Datei beibehalten (Apache 2.0 / CC BY-SA 4.0 Lizenzen).

• Es wird kein Telemetrie- oder Tracking-Code in Notebooks eingefügt. Analytics (Umami) läuft nur auf der doQumentation-Website, nicht in exportierten Notebooks.

Quellcode

Alle Transformationen sind in scripts/sync-content.py implementiert.