search

mui / mui-toolpad

Toolpad Studio: Low-code admin builder. Open-source and powered by MUI.
https://mui.com/toolpad/
MIT License
805 stars 201 forks source link

[docs] Improve users' search experience by taking them to the correct MUI Product > component page #3527

Open prakhargupta1 opened 1 week ago

prakhargupta1 commented 1 week ago

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

oliviertassinari commented 1 week ago

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: https://github.com/mui/mui-toolpad/issues/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.