Skip to content

Add and clean up documentation website links for issue #766#1159

Merged
1ucian0 merged 11 commits into
Qiskit:mainfrom
spital:fix/add-missing-documentation-urls-766
May 21, 2026
Merged

Add and clean up documentation website links for issue #766#1159
1ucian0 merged 11 commits into
Qiskit:mainfrom
spital:fix/add-missing-documentation-urls-766

Conversation

@spital
Copy link
Copy Markdown
Contributor

@spital spital commented May 19, 2026

Summary

This PR audits the member TOML files for issue #766 and updates documentation fields where a usable documentation website could be identified.

Current diff versus main:

  • 48 member TOML files changed.
  • 45 documentation fields added.
  • 5 documentation lines removed/replaced.
  • 94 member TOML files now have a documentation field.
  • 31 member TOML files intentionally remain without documentation because I did not find a project-specific deployed documentation website.

Notable changes

  • Added documentation links for entries with verifiable rendered documentation sites, including ReadTheDocs, GitHub Pages, official provider docs, IBM Quantum docs, Microsoft Azure Quantum docs, Quantinuum docs, PennyLane docs, qBraid docs, Superstaq docs, TorchQuantum docs, etc.
  • Updated Qiskit Scaleway from PyPI metadata to the official Scaleway Quantum quickstart page:
    • https://www.scaleway.com/en/docs/quantum-computing/quickstart/
  • Updated HLQuantum from a GitHub docs/ source directory to the deployed GitHub Pages documentation site:
    • https://alindanielferenczi.github.io/HLQuantum/
  • Removed documentation fields that were not documentation websites, for example:
    • FAdam-VQE: previous documentation was the arXiv paper, which is already represented as a paper/project reference rather than docs.
    • QCRAFT AutoScheduler: previous documentation was a GitHub README; the repository has Sphinx docs source, but I did not find a live deployed docs site.
    • Qx86: previous documentation was the repository root, not a documentation website.

How remaining missing documentation entries were handled

The files below were audited but intentionally left without a documentation field. In most cases the only available material was a README, a GitHub docs/ source directory, a notebook, a paper, a dependency/framework docs link, or a project/company page. Those were not added because they do not satisfy the stricter “documentation website” interpretation of issue #766.

File Project Reason no documentation field was added
arvaklite_7fcadf8b.toml arvak-lite README links to generic IBM transpiler-plugin docs and the project has a website, but I did not find project-specific rendered documentation.
calanquan_8868c7af.toml CALA-n Quantum Library README/usage information exists in the repository, but no deployed project documentation website was found.
conditional_dc917437.toml Conditional Measurement Toolbox Repository README exists, but no project-specific deployed docs website was found.
denseev_f305aa07.toml dense-ev Repository README exists, but no project-specific deployed docs website was found.
dynacir_ee3eb036.toml dynacir Repository README exists, but no project-specific deployed docs website was found.
fadamvqe_e4d840cb.toml FAdam-VQE The previous docs URL was an arXiv paper; no separate deployed documentation website was verified.
galanquan_36e10568.toml GALA-n Quantum Library README/usage information exists in the repository, but no deployed project documentation website was found.
grovercont_40b3b309.toml Grover controlled-diffuser (CUs) README/usage information exists in the repository, but no deployed project documentation website was found.
gulps_0a8128d0.toml GULPS README references Weyl chamber ReadTheDocs, but that appears to be dependency/background documentation, not GULPS-specific docs.
largescale_67bfc31d.toml (Large-scale) Quantum Network Coding Repository contains a docs/ directory and references docs/requirements.txt, but I found no deployed documentation website.
naturecp2k_a08d66f6.toml Qiskit Nature + CP2K Embedding Repository README exists, but no project-specific deployed docs website was found.
qasmrunner_5b05d5a3.toml QASM Runner for IBM platforms Repository README exists, but no project-specific deployed docs website was found.
qbalance_88affdcb.toml qBalance Repository README/PyPI metadata exists, but no rendered project documentation website was found.
qclib_727120b2.toml Qclib README and package metadata exist, but no separate deployed documentation website was found.
qcraftauto_cec38ad8.toml QCRAFT AutoScheduler Repository has Sphinx docs source under docs/, but expected GitHub Pages/ReadTheDocs URLs returned 404. No deployed docs site was verified.
qdao_c39a1176.toml qdao README links to external Qiskit Aer documentation, but I did not find qdao-specific deployed docs.
qiskitoptj_fd796b7d.toml QiskitOpt.jl README links to generic Qiskit fake-backend API docs; no QiskitOpt.jl-specific deployed docs were found.
qomm_b1285a61.toml qOMM Repository README exists, but no project-specific deployed docs website was found.
qpong_56eb0ca6.toml QPong Repository README exists, but no project-specific deployed docs website was found.
quantumdeb_3728ab3d.toml Quantum Debugger README links to external Debug Adapter Protocol / PyTKET docs, but no Quantum Debugger-specific deployed docs were found.
quantummas_e6e7a086.toml Quantum MasterChef Repository README exists, but no project-specific deployed docs website was found.
quantumnet_0533cf1a.toml Quantum Network Coding Repository contains a docs/ directory and references docs/requirements.txt, but I found no deployed documentation website.
quantumpro_bb5d0da9.toml Quantum Prototype Template Repository has Sphinx docs source and a gh-pages branch with rendered HTML, but the expected public Pages URL currently returns 404, so no live docs website was verified.
qubit_5870b3e3.toml Qubit Repository README exists, but no project-specific deployed docs website was found.
qubitreuse_c9369922.toml qiskit-qubit-reuse Repository README exists, but no project-specific deployed docs website was found.
qupepfold_ab89baa7.toml QuPepFold Repository README exists, but no project-specific deployed docs website was found.
qvoting_64b432d7.toml qvoting Repository README exists, but no project-specific deployed docs website was found.
qx86_a68e9142.toml Qx86 Previous documentation was the repository root. I did not find a deployed documentation website.
symb_9350b230.toml qiskit-symb Repository README/usage examples exist, but no project-specific deployed docs website was found.
truncatedv_6e4000a2.toml truncated Variational Hamiltonian Ansatz tVHA README links to old external Qiskit/Gaussian documentation and mentions “the documentation”, but I did not find tVHA-specific deployed docs.
variational_05140a48.toml Variational Quantum Linear Solver Prototype Repository has Sphinx-like docs source, but expected GitHub Pages/ReadTheDocs URLs returned 404. No deployed docs site was verified.

Notes on docs source versus deployed docs

A few repositories have useful documentation source, but I did not treat source trees as valid documentation URLs unless I could find a rendered site:

  • QCRAFT AutoScheduler has Sphinx files such as docs/source/conf.py, index.rst, usage.rst, and a docs Makefile, but I did not find a live GitHub Pages or ReadTheDocs deployment.
  • Quantum Prototype Template has a workflow that builds Sphinx docs and pushes rendered HTML to gh-pages. The gh-pages branch contains index.html, objects.inv, and _static/, but https://qiskit-community.github.io/quantum-prototype-template/ currently returns 404, so I did not treat it as a live documentation website.
  • HLQuantum was the positive case from this review: its GitHub docs/ source is deployed at https://alindanielferenczi.github.io/HLQuantum/, so the TOML now uses the rendered site instead of the repository source path.
  • Several projects have GitHub docs/, tutorials/, or notebook directories that are viewable in GitHub, but those are repository source paths rather than deployed documentation websites.

Validation

  • Parsed every resources/members/*.toml file with Python tomllib: 0 parse errors.
  • git diff --check main passed with no whitespace errors.
  • Current counts:
    • documentation present: 94 member TOML files.
    • documentation missing after audit: 31 member TOML files.

Closes #766

Copy link
Copy Markdown
Member

@1ucian0 1ucian0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work. Thanks!

Comment thread resources/members/braketprov_de20c734.toml Outdated
Comment thread resources/members/ibmruntime_964baff2.toml Outdated
Comment thread resources/members/installerf_7352f04f.toml Outdated
Comment thread resources/members/mitiq_a4ba9712.toml Outdated
Comment thread resources/members/psfzero_ec4cc7b4.toml
Comment thread resources/members/quantumins_fb1cd889.toml Outdated
Comment thread resources/members/rigettipro_88a73f80.toml Outdated
Comment thread resources/members/rs_0f1aa4a6.toml Outdated
Comment thread resources/members/scaleway_a942dc5d.toml Outdated
Comment thread resources/members/zoosecodes_255ca532.toml Outdated
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 21, 2026

CLA assistant check
All committers have signed the CLA.

spital and others added 9 commits May 21, 2026 10:57
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
@spital spital requested a review from 1ucian0 May 21, 2026 09:19
Copy link
Copy Markdown
Member

@1ucian0 1ucian0 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! LGTM!

@1ucian0 1ucian0 added this pull request to the merge queue May 21, 2026
Merged via the queue into Qiskit:main with commit 86c07f7 May 21, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add missing docs websites

3 participants