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] Improve users' search experience by taking them to the correct MUI Product > component page #3527

Open
prakhargupta1 opened this issue May 6, 2024 · 1 comment
Labels
docs Improvements or additions to the documentation priority: low To delay as much as possible

Comments

@prakhargupta1
Copy link
Member

prakhargupta1 commented May 6, 2024

Summary

Currently, a lot of users land on Toolpad component pages through search queries like mui <component name>. This sabotages their experience as it takes them some time to figure out they are on the wrong page. The linked Material UI component page assists users in moving to the right page without explicitly searching for it, but we can improve this further.

Option 1

We add a Warning call out, explaining to users that it is a component page for Toolpad.

Option 2

We support different doc themes for MUI products, with logos and a bigger product name.

Option 3

As discussed here, moving away from sub-folder structure to sub-domain structure, the user then will see toolpad.mui.com, a different favicon, site name and will avoid clicking it.

Search keywords: search

@prakhargupta1 prakhargupta1 added status: waiting for maintainer These issues haven't been looked at yet by a maintainer priority: low To delay as much as possible docs Improvements or additions to the documentation and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels May 6, 2024
@oliviertassinari
Copy link
Member

Part of the value is going from

SCR-20240510-prbm

to

SCR-20240510-prau

But I think it's also about communicating that the value is beyond Material UI and MUI X.

Related to: #3373.

It feels about https://www.notion.so/mui-org/toolpad-Rename-MUI-Toolpad-to-Toolpad-06be3fdb6c9843e8967bbdecaaf453ec, but maybe there isn't that much of a strong appeal in the short term to do MUI Toolpad -> Toolpad.

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 priority: low To delay as much as possible
Projects
None yet
Development

No branches or pull requests

2 participants