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

Add Introduction to Documentation #110

Merged
merged 11 commits into from
Jun 3, 2021
Merged

Conversation

lazyoracle
Copy link
Member

What

Add an introduction section to the online docs, continuing work on issue #17

Why

Newcomers find it difficult to grasp what the different parts of the codebase mean and how they interact with each other

How

Add sections explaining the following:

  • The three building blocks:
    • Device Model
    • Classical Electronics
    • Instructions
  • Parameter Map
  • Experiment
  • Optimizer
  • Libraries

@lazyoracle lazyoracle added the documentation Improvements or additions to documentation label Jun 3, 2021
@lazyoracle lazyoracle added this to the 1.3 milestone Jun 3, 2021
@lazyoracle lazyoracle self-assigned this Jun 3, 2021
@codecov
Copy link

codecov bot commented Jun 3, 2021

Codecov Report

Merging #110 (cdc773d) into dev (eddeaef) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev     #110   +/-   ##
=======================================
  Coverage   57.34%   57.34%           
=======================================
  Files          35       35           
  Lines        5291     5291           
=======================================
  Hits         3034     3034           
  Misses       2257     2257           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eddeaef...cdc773d. Read the comment docs.

@lazyoracle lazyoracle merged commit d5814e4 into q-optimize:dev Jun 3, 2021
@lazyoracle lazyoracle deleted the docs-intro branch June 3, 2021 19:50
@lazyoracle lazyoracle mentioned this pull request Aug 18, 2021
17 tasks
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.

1 participant