-
-
Notifications
You must be signed in to change notification settings - Fork 32.5k
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-infra] Tweak feedback footer section design #36556
Conversation
Netlify deploy previewhttps://deploy-preview-36556--material-ui.netlify.app/ Bundle size report |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few additional tasks I haven't done yet in this PR due to... I don't know how + need help
For the translations, unless @mj12albert would like to take on an objective to go after the Chinese community, it's not needed.
For the dedicated roadmap, GitHub issues, changelog per projects, we don't have the infrastructure for it.
Great idea! And it looks really clean too! 👏 |
Co-authored-by: Sam Sycamore <[email protected]> Signed-off-by: Danilo Leal <[email protected]>
Reviving this PR with a slightly different approach than last time ⎯ I'm curious to see what you all think! |
@alexfauquette This is a good suggestion! Just pushed it 😬 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm into it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good for me too 👍
@oliviertassinari Any thoughts from you (maybe particularly about the "Edit this page" reposition) before merging it? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't think of anything else.
The move of the GitHub button to the footer makes a lot of sense to me:
- I think most of the other docs are training developers to find it at the footer, not at the top.
- It also makes more content visible above the fold.
<IconButton | ||
target="_blank" | ||
rel="noopener noreferrer" | ||
href="https://twitter.com/MUI_hq" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should these be project or company links? projects might make more sense like on https://react.dev/learn
href="https://twitter.com/MUI_hq" | |
href="https://twitter.com/MaterialUI" |
I think I will be more likely to use a GitHub link here (the same one as in the header), more than the other link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll check if I can get this link to work dynamically (i.e., if you're visiting Joy UI's docs, it's Joy's Twitter account, etc.). Though that wouldn't work super well for products we may not have an account (not sure but maybe System?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'll go with a simpler approach now — we can iterate later on if we want to have the Twitter link dynamic per product!
title="Twitter" | ||
size="small" | ||
> | ||
<TwitterIcon fontSize="small" sx={{ color: 'grey.500' }} /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe soon :)
This current version of the PR is a simplified take on its original version. My main goal with it is better to use the documentation footer space in a non-intrusive way, potentially adding more traction to channels and links previously accessible through the website footer.
A new and notable change here is removing the "Edit this page" from the top of the page and adding it to the footer. I think we could clear that space up there and make it closer to other page-related actions (primarily the like/dislike). We may discuss if this impacts engagement with this "feature" ⎯ it's a common design pattern across multiple libraries, though, so I don't think there would be a gigantic discoverability impact.
👉 https://deploy-preview-36556--material-ui.netlify.app/joy-ui/react-button/
Overall changes