Edit documentation

ShortestPathLab · Feb 15, 2024 · e39817a · e39817a
1 parent a84624d
commit e39817a
Show file tree

Hide file tree

Showing 16 changed files with 471 additions and 630 deletions.
diff --git a/docs/4-user-guide/interface-labeled.png b/docs/4-user-guide/interface-labeled.png
diff --git a/docs/4-user-guide/interface.md b/docs/4-user-guide/interface.md
@@ -0,0 +1,49 @@
+---
+sidebar_position: 2
+---
+
+# User Interface
+
+Visualiser's interface is made of composable panels. You can add, remove, and rearrange the UI to your desire. This allows Visualiser to support a range of tasks, whether you're using it to learn, showcase, or debug algorithms.
+
+![Alt text](interface.png)
+
+![Alt text](interface-labeled.png)
+
+## Core Panels
+
+When you first open Visualiser, it displays the following panels:
+
+### Recipes
+
+### Layers
+
+Allows you to inspect and edit the layers that are currently being rendered.
+
+[See more information on the Layers Panel](./layers).
+
+### Viewport
+
+Displays the visualisation.
+
+[See more information on the Viewport Panel](./viewport).
+
+### Steps
+
+Displays the steps of the visualisation.
+
+[See more information on the Steps Panel](./steps).
+
+## Customising Panels
+
+### Choosing Content for a Panel
+
+You can choose what content to display in a panel by clicking the dropdown menu on the top left.
+
+![Alt text](page-select.png)
+
+### Add and Remove Panels
+
+You can find panel controls in the extras menu on the top right. Add more panels by splitting existing menus horizontally or vertically.
+
+![Alt text](split.png)
diff --git a/docs/4-user-guide/interface.png b/docs/4-user-guide/interface.png
diff --git a/docs/4-user-guide/layers.md b/docs/4-user-guide/layers.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 4
+---
+
+# Layers Panel
+
+[TODO]
diff --git a/docs/4-user-guide/page-select.png b/docs/4-user-guide/page-select.png
diff --git a/docs/4-user-guide/split.png b/docs/4-user-guide/split.png
diff --git a/docs/4-user-guide/steps.md b/docs/4-user-guide/steps.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 5
+---
+
+# Steps Panel
+
+[TODO]
diff --git a/docs/4-user-guide/viewport.md b/docs/4-user-guide/viewport.md
@@ -0,0 +1,17 @@
+---
+sidebar_position: 3
+---
+
+# Viewport Panel
+
+[TODO]
+
+Pipe Adapter
+
+Weighted A*
+-> Map support
+--> Edit Layer options to specify color of tile
+--> Make changes to grid parser
+-> Multiple solution
+
+Layer name bug
diff --git a/docs/5-tutorials/image.png b/docs/5-tutorials/image.png
diff --git a/docs/5-tutorials/single-agent-grid.mdx b/docs/5-tutorials/single-agent-grid.mdx
@@ -36,9 +36,6 @@ This should be the result:
 
 ![Loaded map](load-grid.png)
 
-Or an example can be downloaded [here](SmallMaze.GRID)
-
-
 ## Prepare the Search Trace
 
 You can generate the search trace in a number of ways depending on your solver.
@@ -47,7 +44,6 @@ You can generate the search trace in a number of ways depending on your solver.
   <TabItem value="raw" label="Demo Search Trace">
     Download [this](./cross-example.trace.yaml) pre-computed search trace.
 
-
     The file should start like this:
 
     ```yaml title="example.trace.yaml"
@@ -74,7 +70,7 @@ You can generate the search trace in a number of ways depending on your solver.
         id: 96
         x: 0
         y: 0
-      - type: destination 
+      - type: destination
         id: 228
         x: 4
         y: 4
@@ -90,15 +86,21 @@ You can generate the search trace in a number of ways depending on your solver.
     - For **Trace**, choose **Choose File**, then pick the search trace from your system.
     - Close the **Edit Layer** modal.
     - In the **Viewport** panel, click **Fit** to fit the map to the viewport.
+
   </TabItem>
   <TabItem value="warthog" label="Warthog">
 
-    by default the solver(warthog) comes with a set of algorithms that users are able to choose 
-
     TODO: explain on how warthog can be download and used through the terminal and produce a search trace
+
   </TabItem>
   <TabItem value="query" label="Query">
 
+    By default, Visualiser is bundled with a WebAssembly version of Warthog, a solver for grid maps.
+
+    Check that **Warthog (WebAssembly)** is enabled in the **Settings** panel, in the **Connections** tab.
+
+    ![Alt text](image.png)
+
     ## Adding the Query
 
     - In the **Layer** panel, click **+ Layer** to add a new layer.
@@ -112,10 +114,10 @@ You can generate the search trace in a number of ways depending on your solver.
     - Left click on any part of the map that you wanted to be set as a source, then **Set as Source**
     - Do the same for the destination click **Set as Destination**
     - A green pixel will show up marking the source
+
   </TabItem>
 </Tabs>
 
-
 ## Step through the Search Trace
 
 - In the **Steps** panel, choose the search trace layer from the layer dropdown. Here, the layer is named **Cross Example**.

diff --git a/docs/4-user-guide/renderer/2D-inbuilts.md → docs/6-api/renderer/2D-inbuilts.md b/docs/4-user-guide/renderer/2D-inbuilts.md → docs/6-api/renderer/2D-inbuilts.md
diff --git a/docs/4-user-guide/renderer/2D-renderer.md → docs/6-api/renderer/2D-renderer.md b/docs/4-user-guide/renderer/2D-renderer.md → docs/6-api/renderer/2D-renderer.md
diff --git a/docs/4-user-guide/renderer/_category_.json → docs/6-api/renderer/_category_.json b/docs/4-user-guide/renderer/_category_.json → docs/6-api/renderer/_category_.json
diff --git a/...user-guide/renderer/standard-renderers.md → docs/6-api/renderer/standard-renderers.md b/...user-guide/renderer/standard-renderers.md → docs/6-api/renderer/standard-renderers.md