Cleanup docs sidebar and improve tutorial (#2866)

FormidableLabs · May 13, 2024 · c0e44aa · c0e44aa
1 parent 74d1a92
commit c0e44aa
Show file tree

Hide file tree

Showing 22 changed files with 256 additions and 585 deletions.
diff --git a/docs/src/content/docs/common-container-props.md b/docs/src/content/docs/common-container-props.md
@@ -1,5 +1,5 @@
 ---
-id: 33
+id: 98
 title: Common Container Props
 category: containers
 sidebar: true

diff --git a/docs/src/content/docs/create-container.md b/docs/src/content/docs/create-container.md
@@ -1,5 +1,5 @@
 ---
-id: 32
+id: 99
 title: createContainer
 category: containers
 type: docs

diff --git a/docs/src/content/docs/victory-area.md b/docs/src/content/docs/victory-area.md
@@ -1,5 +1,5 @@
 ---
-id: 4
+id: 1
 title: VictoryArea
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-axis.md b/docs/src/content/docs/victory-axis.md
@@ -1,5 +1,5 @@
 ---
-id: 5
+id: 2
 title: VictoryAxis
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-bar.md b/docs/src/content/docs/victory-bar.md
@@ -1,5 +1,5 @@
 ---
-id: 6
+id: 3
 title: VictoryBar
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-boxplot.md b/docs/src/content/docs/victory-boxplot.md
@@ -1,5 +1,5 @@
 ---
-id: 0
+id: 4
 title: VictoryBoxPlot
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-candlestick.md b/docs/src/content/docs/victory-candlestick.md
@@ -1,5 +1,5 @@
 ---
-id: 8
+id: 5
 title: VictoryCandlestick
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-canvas.md b/docs/src/content/docs/victory-canvas.md
@@ -8,7 +8,9 @@ scope: null
 
 # Victory Canvas
 
-The `victory-canvas` package currently provides a set of experimental primitive components that will allow Victory to render data in a Canvas container rather than as an SVG.
+The `victory-canvas` package currently provides a set of *experimental* primitive components that will allow Victory to render data in a Canvas container rather than as an SVG.
+
+> This API should not be used in production and only serves as an experiment to help guide the next phase of Victory development.
 
 ## Container Components
 

diff --git a/docs/src/content/docs/victory-chart.md b/docs/src/content/docs/victory-chart.md
@@ -1,7 +1,7 @@
 ---
-id: 9
+id: 1
 title: VictoryChart
-category: charts
+category: containers
 type: docs
 scope:
   - sampleData

diff --git a/docs/src/content/docs/victory-errorbar.md b/docs/src/content/docs/victory-errorbar.md
@@ -1,5 +1,5 @@
 ---
-id: 13
+id: 6
 title: VictoryErrorBar
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-group.md b/docs/src/content/docs/victory-group.md
@@ -1,7 +1,7 @@
 ---
 id: 14
 title: VictoryGroup
-category: charts
+category: containers
 type: docs
 scope:
   - sampleData

diff --git a/docs/src/content/docs/victory-histogram.md b/docs/src/content/docs/victory-histogram.md
@@ -1,5 +1,5 @@
 ---
-id: 35
+id: 7
 title: VictoryHistogram
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-line.md b/docs/src/content/docs/victory-line.md
@@ -1,5 +1,5 @@
 ---
-id: 17
+id: 8
 title: VictoryLine
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-pie.md b/docs/src/content/docs/victory-pie.md
@@ -1,5 +1,5 @@
 ---
-id: 18
+id: 9
 title: VictoryPie
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-polar-axis.md b/docs/src/content/docs/victory-polar-axis.md
@@ -1,5 +1,5 @@
 ---
-id: 19
+id: 10
 title: VictoryPolarAxis
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-scatter.md b/docs/src/content/docs/victory-scatter.md
@@ -1,5 +1,5 @@
 ---
-id: 22
+id: 11
 title: VictoryScatter
 category: charts
 type: docs

diff --git a/docs/src/content/docs/victory-stack.md b/docs/src/content/docs/victory-stack.md
@@ -1,7 +1,7 @@
 ---
 id: 25
 title: VictoryStack
-category: charts
+category: containers
 type: docs
 scope:
   - sampleData

diff --git a/docs/src/content/docs/victory-voronoi.md b/docs/src/content/docs/victory-voronoi.md
@@ -1,5 +1,5 @@
 ---
-id: 30
+id: 12
 title: VictoryVoronoi
 category: charts
 type: docs