Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Link Toolpad core docs to the docs menu #42952

Merged
merged 13 commits into from
Aug 5, 2024

Conversation

prakhargupta1
Copy link
Member

@prakhargupta1 prakhargupta1 commented Jul 16, 2024

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

@prakhargupta1 prakhargupta1 added the docs Improvements or additions to the documentation label Jul 16, 2024
@mui-bot
Copy link

mui-bot commented Jul 16, 2024

@prakhargupta1 prakhargupta1 marked this pull request as ready for review July 17, 2024 11:34
@prakhargupta1 prakhargupta1 changed the title [docs] Link Toolpad core docs to the product menu [docs] Link Toolpad core docs to the docs menu Jul 17, 2024
Copy link
Member

@Janpot Janpot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Not ready to merge until ready on Toolpad side.

@prakhargupta1
Copy link
Member Author

prakhargupta1 commented Jul 17, 2024

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.

@Janpot
Copy link
Member

Janpot commented Jul 17, 2024

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?

@prakhargupta1
Copy link
Member Author

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.

@Janpot
Copy link
Member

Janpot commented Jul 18, 2024

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

Co-authored-by: Jan Potoms <[email protected]>
Signed-off-by: Prakhar Gupta <[email protected]>
Copy link
Member

@Janpot Janpot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving, but to be merged once Toolpad landing page is ready

@apedroferreira apedroferreira self-assigned this Jul 29, 2024
@Janpot
Copy link
Member

Janpot commented Jul 30, 2024

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

@bharatkashyap
Copy link
Member

bharatkashyap commented Aug 1, 2024

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

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 1, 2024
@apedroferreira
Copy link
Member

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?

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 2, 2024
Copy link
Member

@apedroferreira apedroferreira left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No more changes needed here either I think.

@prakhargupta1
Copy link
Member Author

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?

@Janpot
Copy link
Member

Janpot commented Aug 5, 2024

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

@prakhargupta1
Copy link
Member Author

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

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

@apedroferreira apedroferreira merged commit 62854f3 into mui:next Aug 5, 2024
19 checks passed
Janpot added a commit that referenced this pull request Aug 5, 2024
@prakhargupta1 prakhargupta1 deleted the add-toolpad-core-to-docs branch August 21, 2024 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants