Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial refactor of the documentation #485

Merged
merged 10 commits into from
Sep 6, 2023
Merged

Initial refactor of the documentation #485

merged 10 commits into from
Sep 6, 2023

Conversation

andrea-pasquale
Copy link
Contributor

@andrea-pasquale andrea-pasquale commented Aug 24, 2023

This PR does the following:

  • Remove outdated sections in the doc.
  • Sync doc with latest version of Qibolab
  • Add all new protocols to the documentation
  • Update developer instructions to facilitate the development of new protocols.
  • Add scheme with available protocols

this is not definitive. It is just an initial refactor. More PRs will be opened after this one in order
to have a proper documentation.

Checklist:

  • Reviewers confirm new code works as expected.
  • Tests are passing.
  • Coverage does not decrease.
  • Documentation is updated.
  • Compatibility with Qibo modules (Please edit this section if the current pull request is not compatible with the following branches).
    • Qibo: master
    • Qibolab: main
    • Qibolab_platforms_qrc: main

@andrea-pasquale andrea-pasquale added the documentation Improvements or additions to documentation label Aug 24, 2023
@andrea-pasquale andrea-pasquale self-assigned this Aug 24, 2023
@codecov
Copy link

codecov bot commented Aug 24, 2023

Codecov Report

Merging #485 (a80a40b) into main (5015685) will not change coverage.
Report is 33 commits behind head on main.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #485   +/-   ##
=======================================
  Coverage   95.95%   95.95%           
=======================================
  Files          61       61           
  Lines        4425     4425           
=======================================
  Hits         4246     4246           
  Misses        179      179           
Flag Coverage Δ
unittests 95.95% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@andrea-pasquale andrea-pasquale linked an issue Aug 25, 2023 that may be closed by this pull request
@andrea-pasquale andrea-pasquale marked this pull request as ready for review August 28, 2023 14:21
@Edoardo-Pedicillo Edoardo-Pedicillo mentioned this pull request Aug 29, 2023
18 tasks
@andrea-pasquale andrea-pasquale added this to the Qibocal 0.0.4 milestone Aug 29, 2023
@andrea-pasquale
Copy link
Contributor Author

andrea-pasquale commented Sep 1, 2023

@Edoardo-Pedicillo could you please upload here the xmind diagram? (The SVG if it is ready)

@andrea-pasquale andrea-pasquale mentioned this pull request Sep 1, 2023
11 tasks
doc/source/getting-started/runcard.rst Outdated Show resolved Hide resolved
doc/source/developer-guides/new_protocol.rst Outdated Show resolved Hide resolved
doc/source/developer-guides/new_protocol.rst Outdated Show resolved Hide resolved
doc/source/developer-guides/new_protocol.rst Outdated Show resolved Hide resolved
doc/source/developer-guides/new_protocol.rst Outdated Show resolved Hide resolved
doc/source/developer-guides/new_protocol.rst Outdated Show resolved Hide resolved
@Edoardo-Pedicillo
Copy link
Contributor

Thank @andrea-pasquale. If you have time, could you add an image of the report of the rotation protocol in the tutorial ?

@andrea-pasquale andrea-pasquale added this pull request to the merge queue Sep 6, 2023
Merged via the queue into main with commit b46902a Sep 6, 2023
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation
3 participants