Modificări Automate de Cod

doQumentation aplică automat un număr mic de modificări conținutului tutorialelor și ghidurilor Qiskit din sursa originală, pentru a asigura o experiență fluidă și interactivă. Această pagină documentează fiecare modificare, astfel încât să poți înțelege exact ce s-a schimbat față de documentația originală IBM Quantum.

Copii de notebook (Deschide în Colab / Binder / Code Engine)

Când dai clic pe Open in Colab, Open in JupyterLab sau Open in Code Engine, primești o copie a notebook-ului original cu următoarele adăugiri:

1. Celulă de notificare de configurare (markdown)

O celulă de tip blockquote este inserată la începutul notebook-ului, explicând că doQumentation a adăugat o celulă de configurare automată. Aceasta conține un link înapoi către această pagină.

2. Celulă de cerințe preliminare (cod)

O celulă de cod este inserată după notificare și:

• Instalează pachetele necesare (qiskit, qiskit-aer, qiskit-ibm-runtime, pylatexenc, plus orice pachete specifice tutorialului detectate prin scanarea importurilor). Instalarea este omisă dacă pachetele sunt deja prezente (de exemplu, pe Binder sau Code Engine, unde sunt preinstalate).
• Oferă un șablon cu credențiale comentat pentru IBM Quantum, astfel încât utilizatorii care doresc să ruleze pe hardware real pot decomenta și completa cheia lor API.

Pe Google Colab, această celulă rulează automat la deschiderea notebook-ului prin flag-ul de metadate cell_execution_strategy: setup.

3. Rescrieri ale căilor de imagine

Căile relative ale imaginilor (/docs/images/..., /learning/images/...) sunt rescrise pentru a funcționa corect în medii de notebook independente.

Pagini MDX (redare în browser)

Tutorialele afișate pe acest site sunt convertite din notebook-uri .ipynb sau fișiere .mdx din sursa originală. Se aplică următoarele transformări:

• Liniile pip install sunt adăugate la blocurile de cod Python care importă pachete terțe, permițând execuția cu un singur clic prin thebelab.
• Secțiunea IBM Tutorial Survey: Se adaugă o notă care clarifică faptul că sondajul aparține IBM Quantum și care trimite către GitHub Issues al doQumentation pentru feedback specific site-ului.
• Widget de feedback: Un widget „A fost util?" este adăugat la finalul fiecărui tutorial, urmărit prin analitice Umami prietenoase cu confidențialitatea.
• Corecturi de sintaxă MDX: Acoladele, ierarhia titlurilor și problemele de compatibilitate JSX sunt corectate automat pentru redarea în Docusaurus.
• OpenInLabBanner: Un banner interactiv este injectat sub titlu, cu butoane pentru a deschide notebook-ul în Colab, Binder sau Code Engine.

Ce NU este modificat

• Conținutul tutorialului în sine (explicații, logica codului, rezultate) nu este niciodată alterat.
• Atribuirea autorilor originali este păstrată prin frontmatter și fișierul NOTICE (licențe Apache 2.0 / CC BY-SA 4.0).
• Niciun cod de telemetrie sau urmărire nu este injectat în notebook-uri. Analiticele (Umami) rulează doar pe site-ul doQumentation, nu în notebook-urile exportate.

Cod sursă

Toate transformările sunt implementate în scripts/sync-content.py.