[docs] Split Toolpad into Studio and Core (#3250)

mui · Mar 8, 2024 · b9612ba · b9612ba
1 parent 94a29cf
commit b9612ba
Show file tree

Hide file tree

Showing 386 changed files with 1,605 additions and 748 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1.bug.yml b/.github/ISSUE_TEMPLATE/1.bug.yml
@@ -1,5 +1,5 @@
 name: Bug report 🐛
-description: Create a bug report for MUI Toolpad.
+description: Create a bug report for Toolpad.
 labels: ['status: waiting for maintainer']
 body:
   - type: markdown

diff --git a/.github/ISSUE_TEMPLATE/2.feature.yml b/.github/ISSUE_TEMPLATE/2.feature.yml
@@ -1,5 +1,5 @@
 name: Feature request 💄
-description: Suggest a new idea for MUI Toolpad.
+description: Suggest a new idea for Toolpad.
 labels: ['status: waiting for maintainer']
 body:
   - type: markdown

diff --git a/.github/ISSUE_TEMPLATE/4.docs-feedback.yml b/.github/ISSUE_TEMPLATE/4.docs-feedback.yml
@@ -1,5 +1,5 @@
 name: Docs feedback
-description: Improve documentation about MUI Toolpad.
+description: Improve documentation about Toolpad.
 labels: ['status: waiting for maintainer', 'support: docs-feedback']
 title: '[docs] '
 body:

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,4 +1,4 @@
 contact_links:
   - name: Support ❔
-    url: https://mui.com/getting-started/support/
-    about: I need support with MUI Toolpad.
+    url: https://mui.com/toolpad/studio/getting-started/support/
+    about: I need support with Toolpad.
diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
-# MUI Toolpad docs
+# Toolpad docs
 
-This is the documentation website of MUI Toolpad.
+This is the documentation website of Toolpad.
 
 To start the docs site in development mode, from the project root, run:
 
@@ -12,7 +12,7 @@ If you do not have yarn installed, select your OS and follow the instructions on
 
 _DO NOT USE NPM, use Yarn to install the dependencies._
 
-Visit the [MUI Toolpad documentation](https://mui.com/toolpad/getting-started/).
+Visit the [Toolpad documentation](https://mui.com/toolpad/studio/getting-started/).
 
 ## How can I add a new demo to the documentation?
 

diff --git a/docs/data/pages.ts b/docs/data/pages.ts
diff --git a/docs/data/toolpad/components/button/ButtonColor.js b/docs/data/toolpad/components/button/ButtonColor.js
diff --git a/docs/data/toolpad/components/button/ButtonSize.js b/docs/data/toolpad/components/button/ButtonSize.js
diff --git a/docs/data/toolpad/components/button/ButtonState.js b/docs/data/toolpad/components/button/ButtonState.js
diff --git a/docs/data/toolpad/components/button/ButtonVariant.js b/docs/data/toolpad/components/button/ButtonVariant.js
diff --git a/docs/data/toolpad/core/api/components/dashboard.md b/docs/data/toolpad/core/api/components/dashboard.md
@@ -0,0 +1,3 @@
+# Dashboard API
+
+<p class="description">Dashboard API reference</p>
diff --git a/docs/data/toolpad/core/api/components/data-grid.md b/docs/data/toolpad/core/api/components/data-grid.md
@@ -0,0 +1,3 @@
+# Data Grid API
+
+<p class="description">Data Grid API reference</p>
diff --git a/docs/data/toolpad/core/api/components/line-chart.md b/docs/data/toolpad/core/api/components/line-chart.md
@@ -0,0 +1,3 @@
+# Line Chart API
+
+<p class="description">Line Chart API reference</p>
diff --git a/docs/data/toolpad/core/api/components/select-filter.md b/docs/data/toolpad/core/api/components/select-filter.md
@@ -0,0 +1,3 @@
+# Select Filter API
+
+<p class="description">Select Filter API reference</p>
diff --git a/docs/data/toolpad/core/api/hooks/use-filter-state.md b/docs/data/toolpad/core/api/hooks/use-filter-state.md
@@ -0,0 +1,3 @@
+# useFilterState API
+
+<p class="description">useFilterState API reference</p>
diff --git a/docs/data/toolpad/core/api/index.md b/docs/data/toolpad/core/api/index.md
@@ -0,0 +1,14 @@
+# API reference
+
+<p class="description">This page contains an index to the most important javascript APIs of Toolpad.</p>
+
+## Components
+
+- [Dashboard](/toolpad/core/api/dashboard/)
+- [Data Grid](/toolpad/core/api/data-grid/)
+- [Line Chart](/toolpad/core/api/line-chart/)
+- [Select Filter](/toolpad/core/api/select-filter/)
+
+## Hooks
+
+- [useFilterState](/toolpad/core/api/use-filter-state/)
diff --git a/docs/data/toolpad/core/components/dashboard.md b/docs/data/toolpad/core/components/dashboard.md
@@ -0,0 +1,3 @@
+# Dashboard
+
+<p class="description">Dashboard component</p>
diff --git a/docs/data/toolpad/core/components/data-grid.md b/docs/data/toolpad/core/components/data-grid.md
@@ -0,0 +1,3 @@
+# Data Grid
+
+<p class="description">Data Grid component</p>
diff --git a/docs/data/toolpad/core/components/index.md b/docs/data/toolpad/core/components/index.md
@@ -0,0 +1,8 @@
+# Components Index
+
+<p class="description">This page contains an index to the component pages that come with Toolpad Core.</p>
+
+- [Dashboard](/toolpad/core/components/dashboard/)
+- [Data Grid](/toolpad/core/components/data-grid/)
+- [Line Chart](/toolpad/core/components/line-chart/)
+- [Select Filter](/toolpad/core/components/select-filter/)
diff --git a/docs/data/toolpad/core/components/line-chart.md b/docs/data/toolpad/core/components/line-chart.md
@@ -0,0 +1,3 @@
+# Line Chart
+
+<p class="description">Line Chart component</p>
diff --git a/docs/data/toolpad/core/components/select-filter.md b/docs/data/toolpad/core/components/select-filter.md
@@ -0,0 +1,3 @@
+# Select Filter
+
+<p class="description">Select Filter component</p>
diff --git a/docs/data/toolpad/core/customization.md b/docs/data/toolpad/core/customization.md
@@ -0,0 +1,3 @@
+# Customization
+
+<p class="description">How to customize Toolpad Core</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Dashboard API

		<p class="description">Dashboard API reference</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Data Grid API

		<p class="description">Data Grid API reference</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Line Chart API

		<p class="description">Line Chart API reference</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Select Filter API

		<p class="description">Select Filter API reference</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# useFilterState API

		<p class="description">useFilterState API reference</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Dashboard

		<p class="description">Dashboard component</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Data Grid

		<p class="description">Data Grid component</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Line Chart

		<p class="description">Line Chart component</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Select Filter

		<p class="description">Select Filter component</p>
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Customization

		<p class="description">How to customize Toolpad Core</p>