Mga Awtomatikong Pagbabago sa Code

Ang doQumentation ay awtomatikong naglalapat ng kaunting mga pagbabago sa upstream na nilalaman ng mga Qiskit tutorial at guide upang masiguro ang isang maayos at interactive na karanasan. Dinodokumento ng pahinang ito ang bawat pagbabago upang maintindihan mo nang eksakto kung ano ang nabago kumpara sa orihinal na IBM Quantum documentation.

Mga kopya ng notebook (Open in Colab / Binder / Code Engine)

Kapag na-click mo ang Open in Colab, Open in JupyterLab, o Open in Code Engine, makakatanggap ka ng kopya ng orihinal na notebook na may mga sumusunod na karagdagan:

1. Setup notice cell (markdown)

May ipinapasok na blockquote cell sa pinakatuktok na nagpapaliwanag na ang doQumentation ay nagdagdag ng awtomatikong setup cell. Ito ay nag-uugnay pabalik sa pahinang ito.

2. Prerequisites cell (code)

May ipinapasok na code cell pagkatapos ng notice na:

• Nag-iinstall ng mga kinakailangang package (qiskit, qiskit-aer, qiskit-ibm-runtime, pylatexenc, kasama ang anumang tutorial-specific na package na natukoy sa pamamagitan ng import scanning). Ang pag-install ay nila-laktawan kung ang mga package ay nakapuwesto na (hal. sa Binder o Code Engine kung saan sila ay pre-installed).
• Nagbibigay ng commented-out na credentials template para sa IBM Quantum, kaya ang mga user na gustong magpatakbo sa totoong hardware ay maaaring mag-uncomment at punan ang kanilang API key.

Sa Google Colab, ang cell na ito ay awtomatikong tumatakbo kapag binuksan ang notebook sa pamamagitan ng cell_execution_strategy: setup metadata flag.

3. Image path rewrites

Ang mga relative image path (/docs/images/..., /learning/images/...) ay isinusulat muli upang gumana nang tama sa mga standalone na notebook environment.

Mga MDX page (in-browser rendering)

Ang mga tutorial na ipinapakita sa website na ito ay ina-convert mula sa upstream .ipynb notebook o .mdx file. Ang mga sumusunod na transform ay inilalapat:

• pip install lines ay idinadagdag sa mga Python code block na nag-iimport ng third-party na package, na nagpapagana ng one-click execution sa pamamagitan ng thebelab.
• IBM Tutorial Survey section: May idinaragdag na note na nililinaw na ang survey ay nabibilang sa IBM Quantum at nag-uugnay sa GitHub Issues ng doQumentation para sa feedback na partikular sa site.
• Feedback widget: Isang "Was this helpful?" widget ang idinaragdag sa ibaba ng bawat tutorial, sinusubaybayan sa pamamagitan ng privacy-friendly na Umami analytics.
• MDX syntax fixes: Ang mga curly brace, heading hierarchy, at JSX compatibility issue ay awtomatikong itinutuwid para sa pag-render ng Docusaurus.
• OpenInLabBanner: Isang interactive na banner ang ipinapasok sa ibaba ng pamagat na may mga button para buksan ang notebook sa Colab, Binder, o Code Engine.

Ano ang HINDI binabago

• Ang mismong nilalaman ng tutorial (mga paliwanag, code logic, output) ay hindi kailanman binabago.
• Ang orihinal na author attribution ay napapanatili sa pamamagitan ng frontmatter at ng NOTICE file (Apache 2.0 / CC BY-SA 4.0 licenses).
• Walang telemetry o tracking code ang ipinapasok sa mga notebook. Ang Analytics (Umami) ay tumatakbo lamang sa doQumentation website, hindi sa mga na-export na notebook.

Source code

Lahat ng transformation ay ipinatupad sa scripts/sync-content.py.