Builder diagram links (#753)

* Allowing reference but ignore reference/bloqade * adding links to API reference in builder diagram.
QuEraComputing · Oct 25, 2023 · d786277 · d786277
1 parent 24108b1
commit d786277
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 11 deletions.
diff --git a/.gitignore b/.gitignore
@@ -81,7 +81,7 @@ docs/_build/
 
 # mkdocs
 site/
-docs/reference/
+docs/reference/bloqade/
 
 # PyBuilder
 .pybuilder/

diff --git a/docs/builder-workflow/overview.md → docs/reference/overview.md b/docs/builder-workflow/overview.md → docs/reference/overview.md
diff --git a/docs/builder-workflow/standard.md → docs/reference/standard.md b/docs/builder-workflow/standard.md → docs/reference/standard.md
@@ -1,10 +1,8 @@
 
 # Build Workflow
-
-``` mermaid
+```mermaid
 
 flowchart TD
-
   ProgramStart(["start"])
 
   Geometry("Geometry or Lattice")
@@ -67,9 +65,13 @@ flowchart TD
   python
   julia"])
 
-  Submit("Execution
-  ------------
+  Execution("
+  Execution hardware only
+  -------------------------------
   run_async()
+
+  Hardware and simulation
+  -------------------------------
   run()
   __call__")
 
@@ -97,7 +99,24 @@ flowchart TD
   Services -->|quera| QuEraBackends;
   Services -->|braket| BraketBackends;
   Services -->|bloqade| BloqadeBackends;
-  QuEraBackends --> Submit;
-  BraketBackends --> Submit;
-  BloqadeBackends --> Submit;
+  QuEraBackends --> Execution;
+  BraketBackends --> Execution;
+  BloqadeBackends --> Execution;
+
+  click ProgramStart "../bloqade/#bloqade.start";
+  click Geometry "../bloqade/atom_arrangement/";
+  click Coupling "../bloqade/builder/drive/";
+  click Detuning "../bloqade/builder/field/#bloqade.builder.field.Detuning";
+  click Rabi "../bloqade/builder/field/#bloqade.builder.field.Rabi";
+  click Amplitude "../bloqade/builder/field/#bloqade.builder.field.Amplitude";
+  click Phase "../bloqade/builder/field/#bloqade.builder.field.Phase";
+  click SpaceModulation "../bloqade/builder/spatial/";
+  click Waveform "../bloqade/builder/waveform/";
+  click Options "../bloqade/builder/pragmas/";
+  click Services "../bloqade/builder/backend/";
+  click QuEraBackends "../bloqade/builder/backend/quera/#bloqade.builder.backend.quera.QuEraDeviceRoute";
+  click BraketBackends "../bloqade/builder/backend/braket/#bloqade.builder.backend.braket.BraketDeviceRoute";
+  click BloqadeBackends "../bloqade/builder/backend/bloqade/#bloqade.builder.backend.bloqade.BloqadeBackend";
+  click Execution "../bloqade/ir/routine/braket/#bloqade.ir.routine.braket.BraketRoutine";
+
 ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -12,8 +12,8 @@ nav:
   - Home: index.md
   - Tutorials: 'https://queracomputing.github.io/bloqade-python-examples/latest/'
   - Reference:
-    - Builder Overview: builder-workflow/overview.md
-    - Builder Standard Diagram: builder-workflow/standard.md
+    - Builder Overview: reference/overview.md
+    - Builder Standard Diagram: reference/standard.md
     - API References : reference/bloqade/
   - Blog:
     - 2023: