Make broken links warnings

ShortestPathLab · Nov 18, 2023 · a376121 · a376121
1 parent 76efd57
commit a376121
Show file tree

Hide file tree

Showing 16 changed files with 166 additions and 136 deletions.
diff --git a/docs/4-user-guide/_category_.json b/docs/4-user-guide/_category_.json
@@ -1,6 +1,7 @@
 {
   "label": "User Guide",
   "position": 4,
+  "collapsed": false,
   "link": {
     "type": "generated-index"
   }

diff --git a/old/examples/grid-astar.trace.json → ...user-guide/examples/grid-astar.trace.json b/old/examples/grid-astar.trace.json → ...user-guide/examples/grid-astar.trace.json
diff --git a/old/examples/tile.trace.json → docs/4-user-guide/examples/tile.trace.json b/old/examples/tile.trace.json → docs/4-user-guide/examples/tile.trace.json
diff --git a/docs/4-user-guide/overview.md b/docs/4-user-guide/overview.md
@@ -1 +1,7 @@
+---
+sidebar_position: 1
+---
+
 # Overview
+
+[TODO]
diff --git a/old/renderers/2D-renderer/2D-inbuilts.md → docs/4-user-guide/renderer/2D-inbuilts.md b/old/renderers/2D-renderer/2D-inbuilts.md → docs/4-user-guide/renderer/2D-inbuilts.md
@@ -3,23 +3,25 @@
 This document covers the four inbuilt components/views for that the 2D renderer implements.
 
 ## Inbuilt Views
-Here are the structures/formats for the different inbuilts for the 2D renderer. All primitives used by these Inbuilts are [2D renderer primitives](). To use any of these `Inbuilt Views` the [renderer]() property of the view must be set to "2d-pixi".
+
+Here are the structures/formats for the different inbuilts for the 2D renderer. All primitives used by these Inbuilts are [2D renderer primitives](about:blank). To use any of these `Inbuilt Views` the [renderer](about:blank) property of the view must be set to "2d-pixi".
 
 ### Grid View
+
 The Grid View is for grid based pathfinding algorithms, on standard 2D plane. Below is the strucutre of the Grid View component.
 
 ```ts
 GridView = {
   "grid-view": [
     {
-      "$": "rect",
-      "width": 1,
-      "height": 1,
-      "x": "{{x}}",
-      "y": "{{y}}"
-    }
-  ]
-}
+      $: "rect",
+      width: 1,
+      height: 1,
+      x: "{{x}}",
+      y: "{{y}}",
+    },
+  ],
+};
 ```
 
 The Grid View can be utilized by using view like the following
@@ -31,108 +33,108 @@ The Grid View can be utilized by using view like the following
 For the search trace to be renderer each event should include an appropriate `x` and `y` coordinate for the `grid-view` to reference too.
 
 ### Polyanya View
+
 The Polyanya View is an example of navigation mesh based pathfinding algorithms, on standard 2D plane. Below is the strucutre of the Polyanya View component.
 
 ```ts
 PolyanyaView = {
-  "node": [
+  node: [
     {
-      "$": "circle",
-      "radius": 1,
-      "x": "{{x1}}",
-      "y": "{{y1}}"
-    }
+      $: "circle",
+      radius: 1,
+      x: "{{x1}}",
+      y: "{{y1}}",
+    },
   ],
-  "line1": [
+  line1: [
     {
-      "$": "path",
-      "points": [
+      $: "path",
+      points: [
         {
-          "x": "{{x2}}",
-          "y": "{{y2}}"
+          x: "{{x2}}",
+          y: "{{y2}}",
         },
         {
-          "x": "{{x3}}",
-          "y": "{{y3}}"
-        }
+          x: "{{x3}}",
+          y: "{{y3}}",
+        },
       ],
-      "lineWidth" : 0.5
-    }
+      lineWidth: 0.5,
+    },
   ],
-  "line2": [
+  line2: [
     {
-      "$": "path",
-      "points": [
+      $: "path",
+      points: [
         {
-          "x": "{{x1}}",
-          "y": "{{y1}}"
+          x: "{{x1}}",
+          y: "{{y1}}",
         },
         {
-          "x": "{{x2}}",
-          "y": "{{y2}}"
-        }
+          x: "{{x2}}",
+          y: "{{y2}}",
+        },
       ],
-      "lineWidth" : 0.5
-    }
+      lineWidth: 0.5,
+    },
   ],
-  "line3": [
+  line3: [
     {
-      "$": "path",
-      "points": [
+      $: "path",
+      points: [
         {
-          "x": "{{x1}}",
-          "y": "{{y1}}"
+          x: "{{x1}}",
+          y: "{{y1}}",
         },
         {
-          "x": "{{x3}}",
-          "y": "{{y3}}"
-        }
+          x: "{{x3}}",
+          y: "{{y3}}",
+        },
       ],
-      "lineWidth" : 0.5
-
-    }
+      lineWidth: 0.5,
+    },
   ],
-  "triangle": [
+  triangle: [
     {
-      "$": "polygon",
-      "points": [
+      $: "polygon",
+      points: [
         {
-          "x": "{{x1}}",
-          "y": "{{y1}}"
+          x: "{{x1}}",
+          y: "{{y1}}",
         },
         {
-          "x": "{{x2}}",
-          "y": "{{y2}}"
+          x: "{{x2}}",
+          y: "{{y2}}",
         },
         {
-          "x": "{{x3}}",
-          "y": "{{y3}}"
-        }
-      ]
-    }
+          x: "{{x3}}",
+          y: "{{y3}}",
+        },
+      ],
+    },
   ],
   "polyanya-view": [
     {
-      "$": "node"
+      $: "node",
     },
     {
-      "$": "line1",
-      "persist": false
+      $: "line1",
+      persist: false,
     },
     {
-      "$": "line2",
-      "persist": false
+      $: "line2",
+      persist: false,
     },
     {
-      "$": "line3",
-      "persist": false
+      $: "line3",
+      persist: false,
     },
     {
-      "$": "triangle",
-      "persist": false
-    }
-  ]
-}
+      $: "triangle",
+      persist: false,
+    },
+  ],
+};
 ```
 
 The Polyanya View can be utilized by using view like the following
@@ -141,51 +143,51 @@ The Polyanya View can be utilized by using view like the following
 "main": { "renderer": "2d-pixi", "components" : {"$":"polyanya-view"}}
 ```
 
-The Polyanya View has 3 main sets of variables that each event should inclue. These are the `x` and `y` coordinate for 3 points. 
+The Polyanya View has 3 main sets of variables that each event should inclue. These are the `x` and `y` coordinate for 3 points.
 
 - (x1,y1) : are the coordinates for the current location/node
 - (x2,y2) : are the coordinates for the [TODO]
 - (x3,y3) : are the coordinates for the [TODO]
 
 ### Road Network View
+
 The Road Network View is for network based pathfinding algorithms, on standard 2D plane. Below is the strucutre of the Road Network View component.
 
 ```ts
 RoadView = {
-"node": [
+  node: [
     {
-      "$": "circle",
-      "radius": 0.3,
-      "x": "{{x}}",
-      "y": "{{y}}"
-    }
+      $: "circle",
+      radius: 0.3,
+      x: "{{x}}",
+      y: "{{y}}",
+    },
   ],
-  "line": [
+  line: [
     {
-      "$": "path",
-      "points": [
+      $: "path",
+      points: [
         {
-          "x": "{{parent.x}}",
-          "y": "{{parent.y}}"
+          x: "{{parent.x}}",
+          y: "{{parent.y}}",
         },
         {
-          "x": "{{x}}",
-          "y": "{{y}}"
-        }
+          x: "{{x}}",
+          y: "{{y}}",
+        },
       ],
-      "lineWidth" : 1
-    }
+      lineWidth: 1,
+    },
   ],
-  "road-view":[
-    {
-        "$": "node"
-      },
-      {
-        "$": "line"
-      }
-  ]
-
-}
+  "road-view": [
+    {
+      $: "node",
+    },
+    {
+      $: "line",
+    },
+  ],
+};
 ```
 
 The Road Network View can be utilized by using view like the following
@@ -197,44 +199,44 @@ The Road Network View can be utilized by using view like the following
 For the search trace to be renderer each event should include an appropriate `x` and `y` coordinate for the `road-view` to reference too.
 
 ### Tree View
+
 The Tree View is for network based pathfinding algorithms, on standard 2D plane. Below is the strucutre of the Road Network View component.
 
 ```ts
 RoadView = {
-"node": [
+  node: [
     {
-      "$": "circle",
-      "radius": 0.3,
-      "x": "{{x}}",
-      "y": "{{y}}"
-    }
+      $: "circle",
+      radius: 0.3,
+      x: "{{x}}",
+      y: "{{y}}",
+    },
   ],
-  "line": [
+  line: [
     {
-      "$": "path",
-      "points": [
+      $: "path",
+      points: [
         {
-          "x": "{{parent.x}}",
-          "y": "{{parent.y}}"
+          x: "{{parent.x}}",
+          y: "{{parent.y}}",
         },
         {
-          "x": "{{x}}",
-          "y": "{{y}}"
-        }
+          x: "{{x}}",
+          y: "{{y}}",
+        },
       ],
-      "lineWidth" : 1
-    }
+      lineWidth: 1,
+    },
+  ],
+  "tree-view": [
+    {
+      $: "node",
+    },
+    {
+      $: "line",
+    },
   ],
-  "tree-view":[
-    {
-        "$": "node"
-      },
-      {
-        "$": "line"
-      }
-  ]
-
-}
+};
 ```
 
 The Road Network View can be utilized by using view like the following
@@ -243,4 +245,4 @@ The Road Network View can be utilized by using view like the following
 "main": { "renderer": "2d-pixi", "components" : {"$":"tree-view"}}
 ```
 
-Currently, the Tree View component is identical in form to the Road View. However, unlike the Road View the Tree View does not require `x` and `y` values for the events. If these are not provided (this is determined by checking if the source has an `x` and `y`) then `x` and `y` will be automatically generated for all the events in a direct tree format.
+Currently, the Tree View component is identical in form to the Road View. However, unlike the Road View the Tree View does not require `x` and `y` values for the events. If these are not provided (this is determined by checking if the source has an `x` and `y`) then `x` and `y` will be automatically generated for all the events in a direct tree format.