Merge pull request #489 from StoneCypher/ImproveDocumentationLayout

Improve documentation layout
StoneCypher · May 26, 2022 · 1c597f9 · 1c597f9
2 parents 6a6f1c8 + 4c2e830
commit 1c597f9
Show file tree

Hide file tree

Showing 34 changed files with 43,688 additions and 11,881 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/benchmark/results/general.chart.html b/benchmark/results/general.chart.html
@@ -28,7 +28,7 @@
   </head>
   <body>
     <div class="container">
-      <canvas id="chart1653260432516" width="16" height="9"></canvas>
+      <canvas id="chart1653540974899" width="16" height="9"></canvas>
     </div>
     <script>
       const format = (num) => {
@@ -51,18 +51,18 @@
           chunked.map((chunk) => chunk.join('')).join(' ') + fractionStr
         )
       }
-      const ctx1653260432516 = document
-        .getElementById('chart1653260432516')
+      const ctx1653540974899 = document
+        .getElementById('chart1653540974899')
         .getContext('2d')
-      const chart1653260432516 = new Chart(ctx1653260432516, {
+      const chart1653540974899 = new Chart(ctx1653540974899, {
         type: 'bar',
         data: {
           labels: ["Blind cycle a traffic light 100 times by transition","Blind cycle a traffic light 100 times by action","Blind cycle a basic-hooked traffic light 100 times by transition","Blind cycle a named-hooked traffic light 100 times by transition","Blind cycle an any-transition traffic light 100 times by transition","Blind cycle an exit hooked traffic light 100 times by transition","Blind cycle an enter hooked traffic light 100 times by transition","Blind cycle a standard-transition hooked light by transition","Blind cycle a main-transition hooked light by transition","Blind cycle a force-transition hooked light by transition","Blind cycle a traffic light 100 times by action","Blind cycle a basic-hooked traffic light 100 times by action","Blind cycle a named-hooked traffic light 100 times by action","Blind cycle an any-action traffic light 100 times by action","Blind cycle a global-action traffic light 100 times by action","Blind cycle an exit hooked traffic light 100 times by action","Blind cycle an enter hooked traffic light 100 times by action","Blind cycle a standard transition tl 100 times by action","Blind cycle a main transition tl 100 times by action","Blind cycle a forced transition tl 100 times by action","Kitchen Sink 100 times"],
           datasets: [
             {
-              data: [33274,68682,6933,31672,31163,28764,28279,29944,30822,145295,65670,7761,7080,55610,54958,48468,48632,320236,322994,326004,47818],
-              backgroundColor: ["hsl(12.251999999999994, 85%, 55%)","hsl(25.283999999999992, 85%, 55%)","hsl(2.5559999999999947, 85%, 55%)","hsl(11.664, 85%, 55%)","hsl(11.472000000000001, 85%, 55%)","hsl(10.583999999999993, 85%, 55%)","hsl(10.404000000000002, 85%, 55%)","hsl(11.027999999999999, 85%, 55%)","hsl(11.340000000000003, 85%, 55%)","hsl(53.483999999999995, 85%, 55%)","hsl(24.168, 85%, 55%)","hsl(2.8559999999999945, 85%, 55%)","hsl(2.6040000000000023, 85%, 55%)","hsl(20.472000000000005, 85%, 55%)","hsl(20.232, 85%, 55%)","hsl(17.84400000000001, 85%, 55%)","hsl(17.904000000000003, 85%, 55%)","hsl(117.876, 85%, 55%)","hsl(118.896, 85%, 55%)","hsl(120, 85%, 55%)","hsl(17.604000000000003, 85%, 55%)"],
-              borderColor: ["hsl(12.251999999999994, 85%, 55%)","hsl(25.283999999999992, 85%, 55%)","hsl(2.5559999999999947, 85%, 55%)","hsl(11.664, 85%, 55%)","hsl(11.472000000000001, 85%, 55%)","hsl(10.583999999999993, 85%, 55%)","hsl(10.404000000000002, 85%, 55%)","hsl(11.027999999999999, 85%, 55%)","hsl(11.340000000000003, 85%, 55%)","hsl(53.483999999999995, 85%, 55%)","hsl(24.168, 85%, 55%)","hsl(2.8559999999999945, 85%, 55%)","hsl(2.6040000000000023, 85%, 55%)","hsl(20.472000000000005, 85%, 55%)","hsl(20.232, 85%, 55%)","hsl(17.84400000000001, 85%, 55%)","hsl(17.904000000000003, 85%, 55%)","hsl(117.876, 85%, 55%)","hsl(118.896, 85%, 55%)","hsl(120, 85%, 55%)","hsl(17.604000000000003, 85%, 55%)"],
+              data: [18681,33601,3011,14462,13982,12840,11760,10388,16092,59092,42955,7390,6849,49267,53194,45215,45579,307664,331658,307097,38968],
+              backgroundColor: ["hsl(6.755999999999995, 85%, 55%)","hsl(12.155999999999995, 85%, 55%)","hsl(1.0919999999999959, 85%, 55%)","hsl(5.231999999999999, 85%, 55%)","hsl(5.063999999999998, 85%, 55%)","hsl(4.6440000000000055, 85%, 55%)","hsl(4.259999999999996, 85%, 55%)","hsl(3.7559999999999945, 85%, 55%)","hsl(5.819999999999993, 85%, 55%)","hsl(21.383999999999993, 85%, 55%)","hsl(15.540000000000004, 85%, 55%)","hsl(2.6760000000000046, 85%, 55%)","hsl(2.4839999999999915, 85%, 55%)","hsl(17.819999999999993, 85%, 55%)","hsl(19.248000000000008, 85%, 55%)","hsl(16.355999999999995, 85%, 55%)","hsl(16.487999999999992, 85%, 55%)","hsl(111.324, 85%, 55%)","hsl(120, 85%, 55%)","hsl(111.108, 85%, 55%)","hsl(14.1, 85%, 55%)"],
+              borderColor: ["hsl(6.755999999999995, 85%, 55%)","hsl(12.155999999999995, 85%, 55%)","hsl(1.0919999999999959, 85%, 55%)","hsl(5.231999999999999, 85%, 55%)","hsl(5.063999999999998, 85%, 55%)","hsl(4.6440000000000055, 85%, 55%)","hsl(4.259999999999996, 85%, 55%)","hsl(3.7559999999999945, 85%, 55%)","hsl(5.819999999999993, 85%, 55%)","hsl(21.383999999999993, 85%, 55%)","hsl(15.540000000000004, 85%, 55%)","hsl(2.6760000000000046, 85%, 55%)","hsl(2.4839999999999915, 85%, 55%)","hsl(17.819999999999993, 85%, 55%)","hsl(19.248000000000008, 85%, 55%)","hsl(16.355999999999995, 85%, 55%)","hsl(16.487999999999992, 85%, 55%)","hsl(111.324, 85%, 55%)","hsl(120, 85%, 55%)","hsl(111.108, 85%, 55%)","hsl(14.1, 85%, 55%)"],
               borderWidth: 2,
             },
           ],

diff --git a/benchmark/results/general.json b/benchmark/results/general.json
@@ -1,138 +1,138 @@
 {
   "name": "General performance suite",
-  "date": "2022-05-22T23:00:32.516Z",
+  "date": "2022-05-26T04:56:14.899Z",
   "version": "1.2.0",
   "results": [
     {
       "name": "Blind cycle a traffic light 100 times by transition",
-      "ops": 33274,
-      "margin": 1.27,
-      "percentSlower": 89.79
+      "ops": 18681,
+      "margin": 7.85,
+      "percentSlower": 94.37
     },
     {
       "name": "Blind cycle a traffic light 100 times by action",
-      "ops": 68682,
-      "margin": 1.26,
-      "percentSlower": 78.93
+      "ops": 33601,
+      "margin": 3.27,
+      "percentSlower": 89.87
     },
     {
       "name": "Blind cycle a basic-hooked traffic light 100 times by transition",
-      "ops": 6933,
-      "margin": 0.57,
-      "percentSlower": 97.87
+      "ops": 3011,
+      "margin": 4.04,
+      "percentSlower": 99.09
     },
     {
       "name": "Blind cycle a named-hooked traffic light 100 times by transition",
-      "ops": 31672,
-      "margin": 0.92,
-      "percentSlower": 90.28
+      "ops": 14462,
+      "margin": 3.36,
+      "percentSlower": 95.64
     },
     {
       "name": "Blind cycle an any-transition traffic light 100 times by transition",
-      "ops": 31163,
-      "margin": 1.1,
-      "percentSlower": 90.44
+      "ops": 13982,
+      "margin": 4.7,
+      "percentSlower": 95.78
     },
     {
       "name": "Blind cycle an exit hooked traffic light 100 times by transition",
-      "ops": 28764,
-      "margin": 1.82,
-      "percentSlower": 91.18
+      "ops": 12840,
+      "margin": 3.88,
+      "percentSlower": 96.13
     },
     {
       "name": "Blind cycle an enter hooked traffic light 100 times by transition",
-      "ops": 28279,
-      "margin": 4.05,
-      "percentSlower": 91.33
+      "ops": 11760,
+      "margin": 7.07,
+      "percentSlower": 96.45
     },
     {
       "name": "Blind cycle a standard-transition hooked light by transition",
-      "ops": 29944,
-      "margin": 1.28,
-      "percentSlower": 90.81
+      "ops": 10388,
+      "margin": 4.21,
+      "percentSlower": 96.87
     },
     {
       "name": "Blind cycle a main-transition hooked light by transition",
-      "ops": 30822,
-      "margin": 0.89,
-      "percentSlower": 90.55
+      "ops": 16092,
+      "margin": 5.56,
+      "percentSlower": 95.15
     },
     {
       "name": "Blind cycle a force-transition hooked light by transition",
-      "ops": 145295,
-      "margin": 0.82,
-      "percentSlower": 55.43
+      "ops": 59092,
+      "margin": 3.62,
+      "percentSlower": 82.18
     },
     {
       "name": "Blind cycle a traffic light 100 times by action",
-      "ops": 65670,
-      "margin": 2.62,
-      "percentSlower": 79.86
+      "ops": 42955,
+      "margin": 3.98,
+      "percentSlower": 87.05
     },
     {
       "name": "Blind cycle a basic-hooked traffic light 100 times by action",
-      "ops": 7761,
-      "margin": 0.97,
-      "percentSlower": 97.62
+      "ops": 7390,
+      "margin": 2.18,
+      "percentSlower": 97.77
     },
     {
       "name": "Blind cycle a named-hooked traffic light 100 times by action",
-      "ops": 7080,
-      "margin": 1.27,
-      "percentSlower": 97.83
+      "ops": 6849,
+      "margin": 1.07,
+      "percentSlower": 97.93
     },
     {
       "name": "Blind cycle an any-action traffic light 100 times by action",
-      "ops": 55610,
-      "margin": 0.87,
-      "percentSlower": 82.94
+      "ops": 49267,
+      "margin": 3.29,
+      "percentSlower": 85.15
     },
     {
       "name": "Blind cycle a global-action traffic light 100 times by action",
-      "ops": 54958,
-      "margin": 2.09,
-      "percentSlower": 83.14
+      "ops": 53194,
+      "margin": 0.91,
+      "percentSlower": 83.96
     },
     {
       "name": "Blind cycle an exit hooked traffic light 100 times by action",
-      "ops": 48468,
-      "margin": 1.08,
-      "percentSlower": 85.13
+      "ops": 45215,
+      "margin": 1.15,
+      "percentSlower": 86.37
     },
     {
       "name": "Blind cycle an enter hooked traffic light 100 times by action",
-      "ops": 48632,
-      "margin": 1.21,
-      "percentSlower": 85.08
+      "ops": 45579,
+      "margin": 1.58,
+      "percentSlower": 86.26
     },
     {
       "name": "Blind cycle a standard transition tl 100 times by action",
-      "ops": 320236,
-      "margin": 2.39,
-      "percentSlower": 1.77
+      "ops": 307664,
+      "margin": 1.29,
+      "percentSlower": 7.23
     },
     {
       "name": "Blind cycle a main transition tl 100 times by action",
-      "ops": 322994,
-      "margin": 2.78,
-      "percentSlower": 0.92
+      "ops": 331658,
+      "margin": 0.87,
+      "percentSlower": 0
     },
     {
       "name": "Blind cycle a forced transition tl 100 times by action",
-      "ops": 326004,
-      "margin": 1.04,
-      "percentSlower": 0
+      "ops": 307097,
+      "margin": 1.89,
+      "percentSlower": 7.41
     },
     {
       "name": "Kitchen Sink 100 times",
-      "ops": 47818,
-      "margin": 0.8,
-      "percentSlower": 85.33
+      "ops": 38968,
+      "margin": 3.14,
+      "percentSlower": 88.25
     }
   ],
   "fastest": {
-    "name": "Blind cycle a forced transition tl 100 times by action",
-    "index": 19
+    "name": "Blind cycle a main transition tl 100 times by action",
+    "index": 18
   },
   "slowest": {
     "name": "Blind cycle a basic-hooked traffic light 100 times by transition",