Write Docs for v0.1.5

[pedromxavier]

This PR aims to close #63.

[codecov-commenter]

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (3e37e5c) 70.56% compared to head (65b0441) 70.56%.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files

@@           Coverage Diff           @@
##           master      #64   +/-   ##
=======================================
  Coverage   70.56%   70.56%           
=======================================
  Files          24       24           
  Lines        1247     1247           
=======================================
  Hits          880      880           
  Misses        367      367           

Impacted Files	Coverage Δ
src/attributes/compiler.jl	59.83% <ø> (ø)
src/compiler/constraints.jl	85.55% <ø> (ø)
src/lib/pbo/quadratization.jl	64.00% <ø> (ø)
src/compiler/architectures.jl	50.00% <100.00%> (ø)
src/model/virtual.jl	87.36% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[bernalde]

Lovely PR; some things to be added in the comments, but if it is not perfect, it is alright. Documentation is a never-ending story.

[bernalde]

There are a couple of typos, but more importantly, I do not know if we should use an image of the D-Wave chip (especially if we do not have copyrights on it). I would rather remove it.

[pedromxavier]

There are a couple of typos, but more importantly, I do not know if we should use an image of the D-Wave chip (especially if we do not have copyrights on it). I would rather remove it.

We took the image from wikimedia commons. I think we should have, if not this one, at least a figure to motivate and catch people's attention with shiny alien-like hardware.

[pedroripper]

There are a couple of typos, but more importantly, I do not know if we should use an image of the D-Wave chip (especially if we do not have copyrights on it). I would rather remove it.

@bernalde we found this image on Wikimedia, so it should be copyright free. But I feel that it is not contributing to the documentation too much. I can remove if you all agree

[bernalde]

This looks good to me!
I could not find the Wikipedia picture of the DWave chip, but I found this other one https://commons.wikimedia.org/wiki/File:DWave_128chip.jpg that has the CC3 License such that we can use it. If you wanna keep the current image, just make sure about the license it has (Wikipedia provides those details)

[pedroripper]

I had to comment these lines because the different dispatches for ToQUBO.toqubo_constraint weren't showing up on the docs.
Does anyone know how to solve this?

https://github.com/psrenergy/ToQUBO.jl/blob/e56193c93d10ad18d8b191dc157f577d9d8de63f/src/compiler/interface.jl#L57-L61

[bernalde]

Is this ready to merge?

[bernalde]

Let's hunt down any mention of Anneal.jl.
I have a question, why do the subsections in the booklet not show up in the navigation bar? I feel that most of the contents of this documentation are hidden

[bernalde]

Some typos here and there

[bernalde]

I agree; this is ready to merge (there is some warning regarding CodeCov integration, should we look into this?)

[pedroripper]

I'll just review if we have checked everything from #63