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] Polish API page design #38196

Merged
merged 10 commits into from
Jul 31, 2023

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Jul 27, 2023

Preview: https://deploy-preview-38196--material-ui.netlify.app/material-ui/api/alert/#props

An iteration on #37405 after the feedback in https://twitter.com/MUI_hq/status/1683914002332635137.

To help with https://twitter.com/goose_plus_plus/status/1683915602425962504 from @dmtrKovalenko, I have:

To help with https://twitter.com/StylesTrip/status/1683927012791193601, I have:

  • Changed a bit the horizontal alignment of the badge

But I think that #38173 will do the reset.

@oliviertassinari oliviertassinari added design This is about UI or UX design, please involve a designer scope: docs-infra Specific to the docs-infra product labels Jul 27, 2023
@mui-bot
Copy link

mui-bot commented Jul 27, 2023

Netlify deploy preview

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

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against d96a1e0

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 but maybe @danilo-leal will have a better opinion

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

danilo-leal commented Jul 31, 2023

Getting up to speed with this PR and just pushed a change that might go in the direction of the listed feedback. I think that removing the bottom border from the header container might help a lot with the content skimming ⎯ here's how it is looking at the moment:

Screen Shot 2023-07-31 at 10 01 05

I explored it without the container's background color + border but felt like it was a bit too naked and spaced out, particularly when seeing the anchor block icon there. But it could work too, although I prefer the above!

Screen Shot 2023-07-31 at 10 03 37

Also, left some commented code on the above commit as we iterate but will for sure clean it up before merging!

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 31, 2023
@oliviertassinari
Copy link
Member Author

oliviertassinari commented Jul 31, 2023

here's how it is looking at the moment:

I like the new separator, feel better 👍

I would personally change two things:

  1. More py on the prop to be easier to read, from 4 to 6px:
Before After
Screenshot 2023-07-31 at 16 15 07 Screenshot 2023-07-31 at 16 14 59
  1. A -37px margin instead of -32px to be able for the prop to stand out but also to have the text with the same vertical alignment
Before After
Screenshot 2023-07-31 at 16 19 49 Screenshot 2023-07-31 at 16 19 43

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Sweet, I had made the left alignment follow the container rather than the text element inside it but both work in my opinion even though I think I'd lean slightly more toward the -32px option. Either way, happy to go this way, too!

Screen Shot 2023-07-31 at 11 28 16

That said, I think this one is good to go! 🚢

@danilo-leal danilo-leal merged commit d62a16c into mui:master Jul 31, 2023
18 checks passed
alexfauquette added a commit to cherniavskii/material-ui that referenced this pull request Aug 1, 2023
richbustos pushed a commit that referenced this pull request Aug 4, 2023
Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com>
richbustos pushed a commit that referenced this pull request Aug 7, 2023
Co-authored-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com>
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
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants