Update workflow images in documentation (#2034)

* add template * change classical shadows workflow * replace rshadows workflow * remove underscore from classical shadows * img substitution * change typos + remove duplicate * change img path to fix docs failure * nicer images * misty's feedback * Update docs/CONTRIBUTING_DOCS.md Co-authored-by: Misty Wahl <[email protected]> * update general template * add new cs workflow * add rs workflow * checklist changes + nate's feedback * remove insert noise channel --------- Co-authored-by: Misty Wahl <[email protected]>
unitaryfund · Dec 18, 2023 · 05be477 · 05be477
1 parent 36138d5
commit 05be477
Show file tree

Hide file tree

Showing 10 changed files with 1,742 additions and 1 deletion.
diff --git a/docs/CONTRIBUTING_DOCS.md b/docs/CONTRIBUTING_DOCS.md
@@ -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

diff --git a/docs/source/guide/shadows.md b/docs/source/guide/shadows.md
@@ -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

diff --git a/docs/source/img/classicalshadow_workflow.png b/docs/source/img/classicalshadow_workflow.png
diff --git a/docs/source/img/classicalshadow_workflow.svg b/docs/source/img/classicalshadow_workflow.svg
diff --git a/docs/source/img/shadows_workflow.png → ...ce/img/classicalshadow_workflow_minli.png b/docs/source/img/shadows_workflow.png → ...ce/img/classicalshadow_workflow_minli.png
diff --git a/docs/source/img/general_template.svg b/docs/source/img/general_template.svg
diff --git a/docs/source/img/mitiq_workflow_template.png b/docs/source/img/mitiq_workflow_template.png
diff --git a/docs/source/img/rshadows_workflow.png b/docs/source/img/rshadows_workflow.png
diff --git a/docs/source/img/rshadows_workflow.svg b/docs/source/img/rshadows_workflow.svg
diff --git a/docs/source/img/rshadows_workflow_minli.png b/docs/source/img/rshadows_workflow_minli.png