material-ui icon indicating copy to clipboard operation
material-ui copied to clipboard

[docs] Link Toolpad core docs to the docs menu

Open prakhargupta1 opened this issue 1 year ago • 5 comments

Preview: https://deploy-preview-42952--material-ui.netlify.app/

Toolpad core linked in the Docs menu:

Screenshot 2024-07-18 at 5 49 58 PM

To fix

  • [x] Studio icon was taken from https://github.com/mui/mui-toolpad/blob/1dc033438f94deb91ecd72ff7c44a775e7303767/packages/toolpad-core/src/DashboardLayout/ToolpadLogo.tsx#L13 but there seems some size issue as it is too small compared to Core logo. => Changed the icon for it to be consistent with other icons.

prakhargupta1 avatar Jul 16 '24 07:07 prakhargupta1

Netlify deploy preview

https://deploy-preview-42952--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad) No bundle size changes

Generated by :no_entry_sign: dangerJS against 7324132dd8b31d2ffc22168e02d816e2c1dab70c

mui-bot avatar Jul 16 '24 07:07 mui-bot

I thought we were doing "Toolpad core" and "Toolpad Studio", but no strong opinion here.

Marija mentioned that Core team has dropped 'Core', so we could use it here. Also having Toolpad in the title helps us keep the overall section less wordy and uses a single Beta badge. So I have kept it like this.

prakhargupta1 avatar Jul 17 '24 12:07 prakhargupta1

Marija mentioned that Core team has dropped Core, so we could use it here.

That could be a reason to keep "Toolpad Core" as to minimize confusion with existing users that conotate "Core" with "MUI core" still.

Studio icon was taken from https://github.com/mui/mui-toolpad/blob/1dc033438f94deb91ecd72ff7c44a775e7303767/packages/toolpad-core/src/DashboardLayout/ToolpadLogo.tsx#L13 but there seems some size issue as it is too small compared to Core logo.

The icon you imported has some internal padding that the original doesn't have. To keep in line with the other icons we perhaps we could pick something we can assign color to? Perhaps there are existing icons that would suit us well?

Janpot avatar Jul 17 '24 12:07 Janpot

That could be a reason to keep "Toolpad Core" as to minimize confusion with existing users that conotate "Core" with "MUI core" still.

Added Toolpad to the product names, it appears to look fine. 👍

To keep in line with the other icons we perhaps we could pick something we can assign color to?

As it would mean changing Toolpad Studio icon at multiple other places. I'll bring this up in our next discussion.

prakhargupta1 avatar Jul 18 '24 11:07 prakhargupta1

As it would mean changing Toolpad Studio icon at multiple other places. I'll bring this up in our next discussion.

That's not what I meant, we could just change it here, to make it look better. The X icon is also not used in this menu.

product-advanced-dark

Janpot avatar Jul 18 '24 11:07 Janpot

Let's also update this menu to link to Toolpad core

Screenshot 2024-07-30 at 14 32 49

=>

Screenshot 2024-07-31 at 17 08 18

Janpot avatar Jul 30 '24 12:07 Janpot

Let's also update this menu to link to Toolpad core

Screenshot 2024-07-31 at 17 08 18

There would be a Logo mismatch in this scenario - The new logo of Toolpad Core isn't the blocks one.

Options:

  1. We can either update the logo in the Product Menu as well; however, that wouldn't go well with the other blocks-based logos in this menu

  2. We can keep the logo the same, and change the copy to be "Toolpad", "Components and tools for dashboards and internal apps" as an umbrella description of Studio and Core

bharatkashyap avatar Aug 01 '24 10:08 bharatkashyap

Let's also update this menu to link to Toolpad core Screenshot 2024-07-31 at 17 08 18

There would be a Logo mismatch in this scenario - The new logo of Toolpad Core isn't the blocks one.

Options:

  1. We can either update the logo in the Product Menu as well; however, that wouldn't go well with the other blocks-based logos in this menu
  2. We can keep the logo the same, and change the copy to be "Toolpad", "Components and tools for dashboards and internal apps" as an umbrella description of Studio and Core

My first thought was option 2, I guess that should be good if we're still using the blocks logo?

apedroferreira avatar Aug 01 '24 21:08 apedroferreira

The docs menu in the preview looks like: Screenshot 2024-08-05 at 6 17 49 PM

There is no mention of Toolpad Core, Is that something we need to fix?

prakhargupta1 avatar Aug 05 '24 12:08 prakhargupta1

That are the toolpad docs, you need to look at the Material UI docs

Janpot avatar Aug 05 '24 13:08 Janpot

That are the toolpad docs, you need to look at the Material UI docs

Got it. Thanks. I think we can merge it.

prakhargupta1 avatar Aug 05 '24 13:08 prakhargupta1