search

Qiskit / documentation

The documentation content home for https://docs.quantum.ibm.com.
https://docs.quantum.ibm.com
Apache License 2.0
37 stars 66 forks source link

Rewrite files with code blocks to Jupyter notebooks #169

Open Eric-Arellano opened 11 months ago

Eric-Arellano commented 11 months ago

Jupyter notebooks have a big advantage over MDX: we can test the code still works, and generate images with the newest code. See https://github.com/Qiskit/documentation/issues/78.

Crucially, they still allow us to use MDX components in their markdown - so we lose little converting from MDX to Jupyter, other than that it's a more complex file format.

@lerongil pointed out in https://github.com/Qiskit/documentation/issues/477 that there is an additional benefit of converting to notebooks: it makes our UX more consistent and useful when we have code blocks.

abbycross commented 6 months ago

@kevinsung Is this a good place to make a list of any .mdx files you won't be converting to .ipynb? If there are any that will stay in .mdx and also need fresh codeblock output to match the 1.0 styling, I can do that in #833 -- and if not, I'll close that issue.

kevinsung commented 6 months ago

@abbycross I marked this issue as "on hold" for now since @javabster and I decided to wait until https://github.com/Qiskit/documentation/issues/524 is finished before doing this. This issue will require a fair amount of coordination so I'll propose a more detailed plan later.