Eric Arellano

This is quite similar to https://github.com/Qiskit/documentation/issues/922, but a bigger scope that we need to communicate what all the top-level requirements are for the notebook. For now, those are the same...

Design: allow changing historical API version filter in search?

1

Follow up to https://github.com/Qiskit/documentation/issues/859. We want to signal to the user that your search for the current API will be filtered to use the historical API version for that API,...

[epic] non-API docs need to handle different versions of Qiskit & Runtime

4

See Abby's comment below for an explanation of the overall problems and some solutions. That discussion resulted in this tasklist: ```[tasklist] ### Tasks - [ ] https://github.com/Qiskit/documentation/issues/922 - [ ]...

We cannot easily test notebooks that run on hardware in CI for every PR because a) there is often a queue and b) it costs actual resources. So, we currently...

Looking at GitHub Actions history in https://github.com/Qiskit/documentation/actions/workflows/preview-docs.yml, I couldn't find any cleanup jobs that have other run. This is plausible because I realized the code for cleanups has been broken...

API pipeline needs to add "front matter" (title / metadata) to several pages

2

These never had front matter. Axel said it's fine for now, but we should improve it soon. > Please fix these files: docs/api/qiskit-ibm-provider/ibm-provider.md,docs/api/qiskit/transpiler_builtin_plugins.md,docs/api/qiskit-ibm-runtime/ibm-runtime.md We need to an `else` clause here:...

Currently, we host in docs.quantum.ibm.com all the API docs for Qiskit that used to be in qiskit.org. Some of these docs are quite old, like Qiskit 0.19 from June 2020...

We can do this now that we're removing the `qiskit` theme. 1. Replace this https://github.com/Qiskit/qiskit_sphinx_theme/blob/4606dfde7fcb0d7f65b7cc83f6c56f05aebda9fb/src/qiskit_sphinx_theme/theme/qiskit-sphinx-theme/base.html#L98-L100 with https://github.com/pradyunsg/furo/blob/035b27651632e20fec2277e7398cdd00dc63a73f/src/furo/theme/furo/base.html#L85 2. Display the theme toggle container https://github.com/Qiskit/qiskit_sphinx_theme/blob/4606dfde7fcb0d7f65b7cc83f6c56f05aebda9fb/src/qiskit_sphinx_theme/assets/styles/qiskit-sphinx-theme.scss#L31-L35 3. Find Carbon icons for the...

Prior versions of the docs should link to more recent versions of the docs

5

It's easy to look at old versions of the docs without realizing there are newer versions. Our previous versions sidebar only shows prior versions, not new ones: Fixing this will...

https://github.com/Qiskit/qiskit_sphinx_theme/blob/main/docs_guide/intro/new_doc_project.rst has extensive instructions on how to deploy docs to qiskit.org, which is no longer supported. Instead, we should give instructions for how to deploy using GitHub Pages, per https://github.com/Qiskit/ecosystem/issues/578.