search

QuTech-Delft / OpenQL

OpenQL: A Portable Quantum Programming Framework for Quantum Accelerators. https://dl.acm.org/doi/10.1145/3474222
https://openql.readthedocs.io
Other
101 stars 44 forks source link

OpenQL documentation is hard to read #300

Closed jvansomeren closed 3 years ago

jvansomeren commented 4 years ago

An entry-level to the OpenQL documentation is needed.

Another complicating aspect is that it describes more detail than currently available. The latter is caused by that the documentation was written with the modularity changes (create passes, create independent IR, make interface with back-end more clear) in mind, while still describing the current system. Proposal is to review the documentation for this aspect when the modularity changes are in place. Hopefully the system is then easier to understand and by that the documentation easier to read.

MiguelSMoreira commented 3 years ago

Hans and Wouter provided first review