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 product identifier #32707

Merged
merged 33 commits into from
Jun 2, 2022

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented May 10, 2022

Closes #32591

To-dos on the docs:

  • Switch from using Links to Chips.
  • Add links to the Chips.
  • Product description appears while hovering the Chip.
  • Chip of the product in view is selected.

To-dos on the website:

  • Add the product identifier to the "Docs" option in the navbar.
  • Think about where should "Get started" on the home page redirect to now (it's currently navigating me to Material UI).

Extras:

  • Create an icon for the Design Kits.
  • Revise the product icons (mostly refine the svgs).
  • Fix inconsistent hover color between Product and Docs menu.

@danilo-leal danilo-leal added the docs Improvements or additions to the documentation label May 10, 2022
@mui-bot
Copy link

mui-bot commented May 10, 2022

No bundle size changes

Generated by 🚫 dangerJS against 18bc587

@siriwatknp
Copy link
Member

@danilo-leal I have completed the rest of the todos. Feel free to do the final adjustment in MuiProductSelector.js (I moved to this file for reusing it)!

@danilo-leal

This comment was marked as resolved.

@danilo-leal
Copy link
Contributor Author

danilo-leal commented May 19, 2022

fyi: I've been chewing on the description showing as we hover the chips and I haven't been really feeling it. It forces having that extra (unbalanced and weird) white space for the description text, and ultimately having both of them (MUI Core's description and each sub-product respectively) looks too busy. I'm leaving it commented for now if we feel like going back to this iteration later on, but, for now, my take is to go without it!

Additionally, each chip should direct to the Overview page of each product-we're in the process of writing those for the remaining products (Base is the only one that's currently released). So I might come back and change that in a follow-up pull request once they're done.

@siriwatknp

This comment was marked as resolved.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label May 23, 2022
@danilo-leal danilo-leal requested a review from a team May 23, 2022 11:56
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label May 23, 2022
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

  1. I think that we have an issue with the UX of the menu (same in https://mui.com/) when leaving the hover of an area, but moving the mouse over the fading away menu, then it reappears. See https://stripe.com/ and https://www.radix-ui.com/docs/primitives/components/navigation-menu for what I think would be a UX that heaves predictably (and hence feel great). I have noticed it moving between the popup of "Products" to "Docs". It would show the "Products" popup instead of the "Docs" one.

hover issue

  1. For the details description of each product, did we consider updating the main description with a fade on hover, e.g. when hovering "MUI System"?

Screenshot 2022-05-23 at 17 14 03

docs/src/modules/utils/useRouterExtra.ts Outdated Show resolved Hide resolved
@danilo-leal
Copy link
Contributor Author

danilo-leal commented May 23, 2022

  1. re: Interesting, might need to take a look on that-might be something with the Popper or Menu component?! @siriwatknp could help with more insights on this one specifically.
  2. re: Yup! See [docs] Improve product identifier #32707 (comment) -that iteration is still commented so you can have a sense of how it feels locally there for you. I'm leaning towards going without it at this time!

@oliviertassinari
Copy link
Member

oliviertassinari commented May 23, 2022

@danilo-leal

  1. We might miss a pointer events none.
  2. Ah, I thought that this comment was about displaying the product description below the chips. I think that it would help to record the UX that the difference things you have tried creates as it can improve the feedback other can give.
  3. I have removed myself from the GitHub teams, this should not have happened:

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label May 24, 2022
@danilo-leal
Copy link
Contributor Author

  1. re: Nice, will add those!
  2. re: Oh, just realized your suggestion is slightly different than what I've done! Though I believe it might suffer from the same issue. But I'll prototype these asap so the result is visible 👍 (Confident to move without it at this moment, though.)

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

I think that we have an issue with the UX of the menu (same in https://mui.com/) when leaving the hover of an area, but moving the mouse over the fading away menu, then it reappears

@danilo-leal I have fixed it.

Copy link
Member

@siriwatknp siriwatknp left a comment

Choose a reason for hiding this comment

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

👍 Great work @danilo-leal !

@mnajdova
Copy link
Member

mnajdova commented Jun 2, 2022

Looks much better 👍 great job @danilo-leal 🥳

@danilo-leal danilo-leal merged commit 1b01716 into mui:master Jun 2, 2022
@danilo-leal danilo-leal deleted the improve-product-identifier branch June 2, 2022 14:01
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.

[docs] Add further improvements to the product identifier
5 participants