Add documentation for Running a Model, Gathering Results, and quantum computing context#92
Add documentation for Running a Model, Gathering Results, and quantum computing context#92
Conversation
… context to examples Co-authored-by: bernalde <[email protected]>
…ences Co-authored-by: bernalde <[email protected]>
|
@copilot consider the fact that there are now instructions for you to deploy the tests of this PR. |
|
Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details. Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
bernalde
left a comment
There was a problem hiding this comment.
The examples is the docs should be made part of the testing infrastructure and tested via CI using Documenter.jl
Co-authored-by: bernalde <[email protected]>
The manual examples are now tested via CI. Converted code blocks to |
Addresses documentation gaps identified in #59: stub pages for "Running a Model" and "Gathering Results" manual sections, and missing context about quantum annealing in examples.
Manual Documentation
Running a Model (
docs/src/manual/2-model.md):ToQUBO.Optimizerand solver selectionGathering Results (
docs/src/manual/3-results.md):Examples Enhanced
Added quantum computing context to each example:
Testing Infrastructure
Manual examples are now part of the CI testing infrastructure:
@exampleblocks for automated testing via Documenter.jlExample Usage
> [!WARNING]
>
>
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
Footnotes
@bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1096178231 ↩
@bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1103288064 ↩
@bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095202165 ↩
@joaquimg, @bernalde in https://github.com/psrenergy/ToQUBO.jl/pull/59#discussion_r1095355993 ↩