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-infra] Tweak feedback footer section design #36556

Merged
merged 16 commits into from
Oct 2, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Mar 18, 2023

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

  • Add the "Edit this page" from the top to the footer
  • Add links to the Blog, Store, and Contact us on the footer
  • Add social media icon links to the footer
  • General polish and design tweaks

@danilo-leal danilo-leal added docs Improvements or additions to the documentation design This is about UI or UX design, please involve a designer labels Mar 18, 2023
@mui-bot
Copy link

mui-bot commented Mar 18, 2023

Netlify deploy preview

https://deploy-preview-36556--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 20224d7

@danilo-leal danilo-leal marked this pull request as ready for review March 20, 2023 22:01
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.

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.

docs/src/modules/components/AppLayoutDocsFooter.js Outdated Show resolved Hide resolved
docs/src/modules/components/AppLayoutDocsFooter.js Outdated Show resolved Hide resolved
docs/src/modules/components/AppLayoutDocsFooter.js Outdated Show resolved Hide resolved
@oliviertassinari oliviertassinari added the scope: docs-infra Specific to the docs-infra product label Mar 23, 2023
@mapache-salvaje
Copy link
Contributor

Great idea! And it looks really clean too! 👏

Co-authored-by: Sam Sycamore <[email protected]>
Signed-off-by: Danilo Leal <[email protected]>
@danilo-leal danilo-leal self-assigned this May 17, 2023
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Aug 16, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Sep 26, 2023
@danilo-leal danilo-leal changed the title [docs] Tweak feedback footer section design [docs-infra] Tweak feedback footer section design Sep 26, 2023
@danilo-leal danilo-leal removed the docs Improvements or additions to the documentation label Sep 26, 2023
@danilo-leal danilo-leal requested review from zanivan and alexfauquette and removed request for gerdadesign September 26, 2023 00:17
@danilo-leal
Copy link
Contributor Author

Reviving this PR with a slightly different approach than last time ⎯ I'm curious to see what you all think!

@alexfauquette
Copy link
Member

I did not look at the initial proposal, but this one looks nice. The edit button at the top was a bit too easy to miss

Did you consider to following reorder? such that what is about the current page is on top and navigation to other pages below

Screenshot from 2023-09-26 10-35-03

@danilo-leal
Copy link
Contributor Author

@alexfauquette This is a good suggestion! Just pushed it 😬

Copy link
Contributor

@mapache-salvaje mapache-salvaje left a 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!

Copy link
Member

@alexfauquette alexfauquette left a 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 👍

docs/src/components/footer/EmailSubscribe.tsx Outdated Show resolved Hide resolved
@danilo-leal
Copy link
Contributor Author

@oliviertassinari Any thoughts from you (maybe particularly about the "Edit this page" reposition) before merging it?

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.

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.

docs/src/modules/components/EditPage.js Show resolved Hide resolved
docs/src/modules/components/AppLayoutDocsFooter.js Outdated Show resolved Hide resolved
<IconButton
target="_blank"
rel="noopener noreferrer"
href="https://twitter.com/MUI_hq"
Copy link
Member

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

Suggested change
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.

Copy link
Contributor Author

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?)

Copy link
Contributor Author

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' }} />
Copy link
Member

@oliviertassinari oliviertassinari Sep 29, 2023

Choose a reason for hiding this comment

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

Likely for a different time & different PR, but

Screenshot 2023-09-30 at 01 58 16

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe soon :)

@danilo-leal danilo-leal merged commit 4b88a01 into master Oct 2, 2023
@danilo-leal danilo-leal deleted the feedback-footer-design-tweaks branch October 2, 2023 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design This is about UI or UX design, please involve a designer scope: docs-infra Specific to the docs-infra product
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

5 participants