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

Update workflow images in documentation #2034

Merged
merged 15 commits into from
Dec 18, 2023
19 changes: 19 additions & 0 deletions docs/CONTRIBUTING_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,25 @@ where `file.md` is the one to be added. For more information on including files
To add information in the guide, please add markdown (`.md`) files to the `docs/guide` directory.
Remember to add new files to the guide's TOC file `docs/source/guide/guide.md`.

### Adding workflow images to the user guide

To insert a workflow to the user's guide of some new technique, a template is available (shown below as a `png`). This template is also available in `svg` format at [mitiq_template.svg](../source/img/general_template.svg).

The `svg` will require edits to the items listed below:

- One word description of the first step of the new technique in `(Edit Step 1)`. For example, if the new technique
requires sampling of the input quantum program, you will edit the text to `1. Sampling`.
- Make changes to `Description of circuit generated by mitiq` to instead briefly provide information about how mitiq is manipulating the input circuit.
- Feel free to change the color scheme in `mitiq.new_technique` of the `svg` file.

```{figure} ../source/img/mitiq_workflow_template.png
---
name: fig-overview-template
---
The diagram shows the workflow template of a new technique in Mitiq.
```


### Adding code examples

All code examples, besides explanations on the use of core software package features, live in the `examples` directory under `docs/source`. You can add
Expand Down
2 changes: 1 addition & 1 deletion docs/source/guide/shadows.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ sample efficiency and demonstrates noise resilience {cite}`chen2021robust`. For
([Classical Shadow Protocol and its Robust Estimation](shadows-5-theory.md)).


```{figure} ../img/shadows_workflow.png
```{figure} ../img/classicalshadow_workflow.png
---
width: 700px
name: shadows-workflow-overview
Expand Down
Binary file modified docs/source/img/classicalshadow_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
605 changes: 605 additions & 0 deletions docs/source/img/classicalshadow_workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
358 changes: 358 additions & 0 deletions docs/source/img/general_template.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/img/mitiq_workflow_template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/img/rshadows_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
759 changes: 759 additions & 0 deletions docs/source/img/rshadows_workflow.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/img/rshadows_workflow_minli.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.