From 63fd5305872dcba36a7ae811c600d354fb21b377 Mon Sep 17 00:00:00 2001 From: Pedro Ferreira <10789765+apedroferreira@users.noreply.github.com> Date: Fri, 25 Oct 2024 17:58:09 +0100 Subject: [PATCH 1/2] Adjust casing and sections in component docs --- .../toolpad/core/components/account/account.md | 4 ++-- .../core/components/app-provider/app-provider.md | 2 +- .../dashboard-layout/dashboard-layout.md | 14 +++++++------- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/data/toolpad/core/components/account/account.md b/docs/data/toolpad/core/components/account/account.md index a706c176a50..09c14501142 100644 --- a/docs/data/toolpad/core/components/account/account.md +++ b/docs/data/toolpad/core/components/account/account.md @@ -16,13 +16,13 @@ The `Account` component is a quick and easy way to display an account management ## States -### Signed In +### Signed in If a `session` object is present, the component is rendered as a dropdown containing the user's account details as well as an option to sign out. {{"demo": "AccountDemoSignedIn.js", "bg": "outlined" }} -### Signed Out +### Signed out When signed out, the component renders as an inline sign in button within the dashboard layout. diff --git a/docs/data/toolpad/core/components/app-provider/app-provider.md b/docs/data/toolpad/core/components/app-provider/app-provider.md index bffc6d437fd..20e2d4129e5 100644 --- a/docs/data/toolpad/core/components/app-provider/app-provider.md +++ b/docs/data/toolpad/core/components/app-provider/app-provider.md @@ -76,7 +76,7 @@ export default function App(props) { } ``` -## Client-side Routing +## Client-side routing The `AppProvider` for React Router includes routing out-of-the-box for projects using [react-router-dom](https://www.npmjs.com/package/react-router-dom). diff --git a/docs/data/toolpad/core/components/dashboard-layout/dashboard-layout.md b/docs/data/toolpad/core/components/dashboard-layout/dashboard-layout.md index 85d404a10ca..92196943efb 100644 --- a/docs/data/toolpad/core/components/dashboard-layout/dashboard-layout.md +++ b/docs/data/toolpad/core/components/dashboard-layout/dashboard-layout.md @@ -42,7 +42,7 @@ The `navigation` prop in the [AppProvider](https://mui.com/toolpad/core/react-ap The flexibility in composing and ordering these different elements allows for a great variety of navigation structures to fit your use case. -### Navigation Links +### Navigation links Navigation links can be placed in the sidebar as items with the format: @@ -52,7 +52,7 @@ Navigation links can be placed in the sidebar as items with the format: {{"demo": "DashboardLayoutNavigationLinks.js", "height": 400, "iframe": true}} -### Navigation Headings +### Navigation headings Navigation headings can be placed in the sidebar as items with the format: @@ -62,7 +62,7 @@ Navigation headings can be placed in the sidebar as items with the format: {{"demo": "DashboardLayoutNavigationHeadings.js", "height": 400, "iframe": true}} -### Navigation Dividers +### Navigation dividers Dividers can can be placed between items in the sidebar as items with the format: @@ -74,7 +74,7 @@ Dividers can can be placed between items in the sidebar as items with the format {{"demo": "DashboardLayoutNavigationDividers.js", "height": 400, "iframe": true}} -### Nested Navigation +### Nested navigation Nested navigation structures can be placed in the sidebar as items with the format: @@ -84,13 +84,13 @@ Nested navigation structures can be placed in the sidebar as items with the form {{"demo": "DashboardLayoutNavigationNested.js", "height": 400, "iframe": true}} -### Navigation Actions +### Navigation actions Navigation links have an optional `action` prop to render any content on the right-side of the respective list item, such as badges with numbers, or buttons to toggle a popover menu. {{"demo": "DashboardLayoutNavigationActions.js", "height": 400, "iframe": true}} -### Navigation Pattern Matching +### Navigation pattern matching Navigation links have an optional `pattern` prop to define a pattern to be matched for the item to be marked as selected. This feature is built on top of the [path-to-regexp](https://www.npmjs.com/package/path-to-regexp) library. Some examples: @@ -121,7 +121,7 @@ The layout sidebar can be hidden if needed with the `hideNavigation` prop. {{"demo": "DashboardLayoutSidebarHidden.js", "height": 400, "iframe": true}} -### Full-size content +## Full-size content The layout content can take up the full available area with styles such as `flex: 1` or `height: 100%`. From bb3f7b975d12f964fe199c289c33c43ae53399c3 Mon Sep 17 00:00:00 2001 From: Prakhar Gupta <92228082+prakhargupta1@users.noreply.github.com> Date: Mon, 28 Oct 2024 18:20:08 +0300 Subject: [PATCH 2/2] fix installation image --- docs/data/toolpad/core/introduction/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/data/toolpad/core/introduction/installation.md b/docs/data/toolpad/core/introduction/installation.md index 6a8bc1a8bba..973e9ffa4f4 100644 --- a/docs/data/toolpad/core/introduction/installation.md +++ b/docs/data/toolpad/core/introduction/installation.md @@ -109,6 +109,6 @@ yarn dev and the following page appears when you run the project locally: -{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/core/installation-1.png", "alt": "Toolpad Core entry point", "caption": "Starting with Toolpad Core", "zoom": true, "indent": 1 }} +{{"component": "modules/components/DocsImage.tsx", "src": "/static/toolpad/docs/core/bootstrap.png", "srcDark": "/static/toolpad/docs/core/bootstrap-dark.png","alt": "Toolpad Core entry point", "caption": "Starting with Toolpad Core", "zoom": true, "indent": 1 }} 5. Installation is complete! Begin building your project by making edits to `(dashboard/page/page.tsx`. To understand how to leverage Toolpad Core to build dashboards quickly, [see the detailed tutorial](/toolpad/core/introduction/tutorial/).