Add and clean up documentation website links for issue #766#1159
Merged
1ucian0 merged 11 commits intoMay 21, 2026
Conversation
1ucian0
requested changes
May 20, 2026
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>
Co-authored-by: Luciano Bello <766693+1ucian0@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR audits the member TOML files for issue #766 and updates
documentationfields where a usable documentation website could be identified.Current diff versus
main:documentationfields added.documentationfield.documentationbecause I did not find a project-specific deployed documentation website.Notable changes
https://www.scaleway.com/en/docs/quantum-computing/quickstart/docs/source directory to the deployed GitHub Pages documentation site:https://alindanielferenczi.github.io/HLQuantum/How remaining missing documentation entries were handled
The files below were audited but intentionally left without a
documentationfield. In most cases the only available material was a README, a GitHubdocs/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.documentationfield was addedarvaklite_7fcadf8b.tomlcalanquan_8868c7af.tomlconditional_dc917437.tomldenseev_f305aa07.tomldynacir_ee3eb036.tomlfadamvqe_e4d840cb.tomlgalanquan_36e10568.tomlgrovercont_40b3b309.tomlgulps_0a8128d0.tomllargescale_67bfc31d.tomldocs/directory and referencesdocs/requirements.txt, but I found no deployed documentation website.naturecp2k_a08d66f6.tomlqasmrunner_5b05d5a3.tomlqbalance_88affdcb.tomlqclib_727120b2.tomlqcraftauto_cec38ad8.tomldocs/, but expected GitHub Pages/ReadTheDocs URLs returned 404. No deployed docs site was verified.qdao_c39a1176.tomlqiskitoptj_fd796b7d.tomlqomm_b1285a61.tomlqpong_56eb0ca6.tomlquantumdeb_3728ab3d.tomlquantummas_e6e7a086.tomlquantumnet_0533cf1a.tomldocs/directory and referencesdocs/requirements.txt, but I found no deployed documentation website.quantumpro_bb5d0da9.tomlgh-pagesbranch with rendered HTML, but the expected public Pages URL currently returns 404, so no live docs website was verified.qubit_5870b3e3.tomlqubitreuse_c9369922.tomlqupepfold_ab89baa7.tomlqvoting_64b432d7.tomlqx86_a68e9142.tomlsymb_9350b230.tomltruncatedv_6e4000a2.tomlvariational_05140a48.tomlNotes on docs source versus deployed docs
A few repositories have useful documentation source, but I did not treat source trees as valid
documentationURLs unless I could find a rendered site:docs/source/conf.py,index.rst,usage.rst, and a docs Makefile, but I did not find a live GitHub Pages or ReadTheDocs deployment.gh-pages. Thegh-pagesbranch containsindex.html,objects.inv, and_static/, buthttps://qiskit-community.github.io/quantum-prototype-template/currently returns 404, so I did not treat it as a live documentation website.docs/source is deployed athttps://alindanielferenczi.github.io/HLQuantum/, so the TOML now uses the rendered site instead of the repository source path.docs/,tutorials/, or notebook directories that are viewable in GitHub, but those are repository source paths rather than deployed documentation websites.Validation
resources/members/*.tomlfile with Pythontomllib: 0 parse errors.git diff --check mainpassed with no whitespace errors.documentationpresent: 94 member TOML files.documentationmissing after audit: 31 member TOML files.Closes #766