From 67bfa20a94c6c7958efb3a7c025a8e36f9a4b612 Mon Sep 17 00:00:00 2001
From: MUI bot <2109932+Janpot@users.noreply.github.com>
Date: Sun, 11 Aug 2024 14:54:16 +0200
Subject: [PATCH 01/14] Address some 404s
---
docs/data/toolpad/core/all-components/all-components.md | 1 -
docs/data/toolpad/core/introduction/overview.md | 2 +-
2 files changed, 1 insertion(+), 2 deletions(-)
diff --git a/docs/data/toolpad/core/all-components/all-components.md b/docs/data/toolpad/core/all-components/all-components.md
index 238a1d667e4..3f35bd6429f 100644
--- a/docs/data/toolpad/core/all-components/all-components.md
+++ b/docs/data/toolpad/core/all-components/all-components.md
@@ -5,5 +5,4 @@
- [App Provider](/toolpad/core/react-app-provider/)
- [Account](/toolpad/core/react-account/)
- [Dashboard Layout](/toolpad/core/react-dashboard-layout/)
-- [Data Grid](/toolpad/core/react-data-grid/)
- [Sign In Page](/toolpad/core/react-sign-in-page/)
diff --git a/docs/data/toolpad/core/introduction/overview.md b/docs/data/toolpad/core/introduction/overview.md
index 46535e3054d..8a86f5812ed 100644
--- a/docs/data/toolpad/core/introduction/overview.md
+++ b/docs/data/toolpad/core/introduction/overview.md
@@ -13,7 +13,7 @@ This framework leverages the existing suite of components offered by MUI, and ti
## Overview
:::info
-Visit the [installation guide](/toolpad/core/installation/) to learn how to install the package correctly.
+Visit the [installation guide](/toolpad/core/introduction/installation/) to learn how to install the package correctly.
:::
Toolpad can be multiple things: a set of low-level primitives for common use-cases like state management across components, a Next.js starter with features like authentication and data-fetching baked-in, or an umbrella framework to help bring together your existing internal tooling applications. To sum up: it is a framework that integrates many disparate libraries with MUI's components, which otherwise require a lot of inefficient glue code to work together. The framework is accessible through a Command Line Interface (CLI) which generates starter code quickly based on features needed or example templates to be followed.
From e4a1385c02de2f291138fcca4b57d85a8d355f71 Mon Sep 17 00:00:00 2001
From: MUI bot <2109932+Janpot@users.noreply.github.com>
Date: Sun, 11 Aug 2024 15:01:46 +0200
Subject: [PATCH 02/14] Update pages.ts
---
docs/data/toolpad/core/pages.ts | 1 +
1 file changed, 1 insertion(+)
diff --git a/docs/data/toolpad/core/pages.ts b/docs/data/toolpad/core/pages.ts
index 561e2e4a8f8..c4c8d5f24cf 100644
--- a/docs/data/toolpad/core/pages.ts
+++ b/docs/data/toolpad/core/pages.ts
@@ -97,6 +97,7 @@ const pages: MuiPage[] = [
children: [
{
pathname: '/toolpad/core/api/components-group',
+ inSideNav: false,
subheader: 'Components',
children: [
...pagesApi,
From 12b517928c1c6832d336338947fa77a6dfe33c4e Mon Sep 17 00:00:00 2001
From: MUI bot <2109932+Janpot@users.noreply.github.com>
Date: Sun, 11 Aug 2024 15:05:33 +0200
Subject: [PATCH 03/14] Add title
---
docs/pages/toolpad/index.js | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/docs/pages/toolpad/index.js b/docs/pages/toolpad/index.js
index e7878c2d4e8..1c3af73fc6f 100644
--- a/docs/pages/toolpad/index.js
+++ b/docs/pages/toolpad/index.js
@@ -1,6 +1,7 @@
import * as React from 'react';
import BrandingCssVarsProvider from 'docs/src/BrandingCssVarsProvider';
import Divider from '@mui/material/Divider';
+import Head from 'docs/src/modules/components/Head';
import CssBaseline from '@mui/material/CssBaseline';
import AppHeader from 'docs/src/layouts/AppHeader';
import AppFooter from 'docs/src/layouts/AppFooter';
@@ -14,6 +15,11 @@ import StudioIntro from '../../src/components/landing/StudioIntro';
export default function Home() {
return (
A framework to build full-stack apps, fast. It can be used as a Next.js starter, or integrated within an existing React project to build dashboards and internal tools.
+A framework to build full-stack apps faster.
This framework leverages the existing suite of components offered by MUI, and ties them together with the most commonly-used backend integrations to help you create dashboards fast. Imagine a React dashboard template but with backend features like authentication, role-based access control and data fetching already included. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance. From b721c98d493da05e8df9e5ead905622dceacff32 Mon Sep 17 00:00:00 2001 From: Prakhar Gupta <92228082+prakhargupta1@users.noreply.github.com> Date: Mon, 19 Aug 2024 14:05:38 +0530 Subject: [PATCH 05/14] edits --- .../core/components/use-notifications/use-notifications.md | 2 +- docs/data/toolpad/core/introduction/overview.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/data/toolpad/core/components/use-notifications/use-notifications.md b/docs/data/toolpad/core/components/use-notifications/use-notifications.md index c500eadfec3..b417aebe815 100644 --- a/docs/data/toolpad/core/components/use-notifications/use-notifications.md +++ b/docs/data/toolpad/core/components/use-notifications/use-notifications.md @@ -6,7 +6,7 @@ components: NotificationsProvider # Notifications -Imperative APIs to show and interact with application notifications
+Imperative APIs to show and interact with application notifications.
Toolpad core offers a set of abstractions that make it easier to interact with notifications. Notifications are used to give short updates to the user about things that are happening during the application lifetime. They appear at the bottom of the screen. The Toolpad API allows for opening multiple notifications concurrenlty. diff --git a/docs/data/toolpad/core/introduction/overview.md b/docs/data/toolpad/core/introduction/overview.md index 32e74c51271..36e89eaa4c1 100644 --- a/docs/data/toolpad/core/introduction/overview.md +++ b/docs/data/toolpad/core/introduction/overview.md @@ -4,9 +4,9 @@ title: Toolpad Overview # Toolpad Core -A framework to build full-stack apps faster.
+A set of full-stack components to build react dashboards.
-This framework leverages the existing suite of components offered by MUI, and ties them together with the most commonly-used backend integrations to help you create dashboards fast. Imagine a React dashboard template but with backend features like authentication, role-based access control and data fetching already included. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance. +Toolpad Core leverages existing MUI components, and ties them with the commonly-used backend integrations to offer a set of full-stack components to help you create responsive react dashboards and internal tools. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance. {{"demo": "../components/dashboard-layout/DashboardLayoutNavigationLinks.js", "height": 640, "iframe": true, "hideToolbar": true}} @@ -16,7 +16,7 @@ This framework leverages the existing suite of components offered by MUI, and ti Visit the [installation guide](/toolpad/core/introduction/installation/) to learn how to install the package correctly. ::: -Toolpad can be multiple things: a set of low-level primitives for common use-cases like state management across components, a Next.js starter with features like authentication and data-fetching baked-in, or an umbrella framework to help bring together your existing internal tooling applications. To sum up: it is a framework that integrates many disparate libraries with MUI's components, which otherwise require a lot of inefficient glue code to work together. The framework is accessible through a Command Line Interface (CLI) which generates starter code quickly based on features needed or example templates to be followed. +Toolpad can be multiple things: a set of low-level primitives for common use-cases like state management across components, a Next.js starter with features like authentication and data-fetching baked-in, or an umbrella framework to help bring together your existing internal tooling applications. To sum up: it's a framework that integrates many disparate libraries with MUI's components, which otherwise require a lot of inefficient glue code to work together. The framework is accessible through a CLI which generates starter code quickly based on features needed or example templates to be followed. The framework follows the open-core model, with some features being available under the MIT license, and some being under a paid license. From 327de2e4cc7b7a949ad478f3062eaa008a5e7dee Mon Sep 17 00:00:00 2001 From: Prakhar Gupta <92228082+prakhargupta1@users.noreply.github.com> Date: Mon, 19 Aug 2024 14:43:40 +0530 Subject: [PATCH 06/14] Ensure sidenav title matches the h1 Like https://mui.com/toolpad/studio/reference/api/create-component/ --- docs/data/toolpad/core/components/use-dialogs/use-dialogs.md | 2 +- .../core/components/use-notifications/use-notifications.md | 2 +- docs/data/toolpad/core/pages.ts | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/data/toolpad/core/components/use-dialogs/use-dialogs.md b/docs/data/toolpad/core/components/use-dialogs/use-dialogs.md index 703134587a2..afb54c320a2 100644 --- a/docs/data/toolpad/core/components/use-dialogs/use-dialogs.md +++ b/docs/data/toolpad/core/components/use-dialogs/use-dialogs.md @@ -4,7 +4,7 @@ title: useDialogs components: DialogsProvider --- -# Dialogs +# useDialogsImperative APIs to open and interact with dialogs.
diff --git a/docs/data/toolpad/core/components/use-notifications/use-notifications.md b/docs/data/toolpad/core/components/use-notifications/use-notifications.md index b417aebe815..4a4fde97fea 100644 --- a/docs/data/toolpad/core/components/use-notifications/use-notifications.md +++ b/docs/data/toolpad/core/components/use-notifications/use-notifications.md @@ -4,7 +4,7 @@ title: useNotifications components: NotificationsProvider --- -# Notifications +# useNotificationsImperative APIs to show and interact with application notifications.
diff --git a/docs/data/toolpad/core/pages.ts b/docs/data/toolpad/core/pages.ts index c4c8d5f24cf..95f6cb5555b 100644 --- a/docs/data/toolpad/core/pages.ts +++ b/docs/data/toolpad/core/pages.ts @@ -85,7 +85,7 @@ const pages: MuiPage[] = [ }, { pathname: '/toolpad/core/react-persistent-state', - title: 'Peristent State', + title: 'Peristent storage state', }, ], }, From 107af1a4e72baddd85491f1f3689e2877a8e7712 Mon Sep 17 00:00:00 2001 From: Prakhar Gupta <92228082+prakhargupta1@users.noreply.github.com> Date: Mon, 19 Aug 2024 15:04:45 +0530 Subject: [PATCH 07/14] more --- README.md | 20 ++++++++++++------- .../toolpad/core/introduction/overview.md | 6 +++--- docs/pages/toolpad/index.js | 3 +-- packages/toolpad-core/README.md | 2 +- 4 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 8d5ca6cbfb4..cc5de26141a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@A set of full-stack components to build react dashboards.
-Toolpad Core leverages existing MUI components, and ties them with the commonly-used backend integrations to offer a set of full-stack components to help you create responsive react dashboards and internal tools. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance. +Toolpad Core is a set of full-stack react components that leverages existing MUI components, and ties them with the commonly-used backend integrations to help you create responsive dashboards and internal tools. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance. {{"demo": "../components/dashboard-layout/DashboardLayoutNavigationLinks.js", "height": 640, "iframe": true, "hideToolbar": true}} @@ -16,9 +16,9 @@ Toolpad Core leverages existing MUI components, and ties them with the commonly- Visit the [installation guide](/toolpad/core/introduction/installation/) to learn how to install the package correctly. ::: -Toolpad can be multiple things: a set of low-level primitives for common use-cases like state management across components, a Next.js starter with features like authentication and data-fetching baked-in, or an umbrella framework to help bring together your existing internal tooling applications. To sum up: it's a framework that integrates many disparate libraries with MUI's components, which otherwise require a lot of inefficient glue code to work together. The framework is accessible through a CLI which generates starter code quickly based on features needed or example templates to be followed. +Toolpad can be multiple things: a set of low-level primitives for common use-cases like state management across components, a Next.js starter with features like authentication and routing, or an umbrella framework to help bring together your existing internal tooling applications. To sum up: it's a framework that integrates many disparate libraries with MUI's components, which otherwise require a lot of inefficient glue code to work together. It's accessible through a CLI which generates starter code quickly based on features needed or example templates to be followed. -The framework follows the open-core model, with some features being available under the MIT license, and some being under a paid license. +It follows the open-core model, with some features being available under the MIT license, and some being under a paid license. ## Features diff --git a/docs/pages/toolpad/index.js b/docs/pages/toolpad/index.js index 5d1b9b7d7ea..9b6271bf5ab 100644 --- a/docs/pages/toolpad/index.js +++ b/docs/pages/toolpad/index.js @@ -2,7 +2,6 @@ import * as React from 'react'; import Head from 'docs/src/modules/components/Head'; import BrandingCssVarsProvider from 'docs/src/BrandingCssVarsProvider'; import Divider from '@mui/material/Divider'; -import Head from 'docs/src/modules/components/Head'; import CssBaseline from '@mui/material/CssBaseline'; import AppHeader from 'docs/src/layouts/AppHeader'; import AppFooter from 'docs/src/layouts/AppFooter'; @@ -17,7 +16,7 @@ export default function Home() { return (A set of full-stack components to build react dashboards.
+A set of full-stack components to build dashboards with React.
Toolpad Core is a set of full-stack react components that leverages existing MUI components, and ties them with the commonly-used backend integrations to help you create responsive dashboards and internal tools. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance. From 2b6b576acbe20a5a9e81813e13c2a0c5baf034b8 Mon Sep 17 00:00:00 2001 From: Jan Potoms <2109932+Janpot@users.noreply.github.com> Date: Mon, 19 Aug 2024 12:49:29 +0200 Subject: [PATCH 11/14] Update README.md Signed-off-by: Jan Potoms <2109932+Janpot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc5de26141a..af3f10b5daf 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@A set of full-stack components to build dashboards with React.
+A set of components to build dashboards with React.
Toolpad Core is a set of full-stack react components that leverages existing MUI components, and ties them with the commonly-used backend integrations to help you create responsive dashboards and internal tools. It comes with the guarantee of MUI's enterprise-tested components, and the Toolpad team's focus on using the latest stable libraries, and prioritising razor-sharp performance. diff --git a/docs/pages/toolpad/index.js b/docs/pages/toolpad/index.js index 9b6271bf5ab..c9edda658bf 100644 --- a/docs/pages/toolpad/index.js +++ b/docs/pages/toolpad/index.js @@ -16,7 +16,7 @@ export default function Home() { return (