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] Revise the Joy UI "Avatar" component page #35152

Merged
merged 3 commits into from Nov 15, 2022

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Nov 14, 2022

Part of #33998

This PR revises the Joy UI "Avatar" component page.

  • style and grammar changes throughout
  • added info on basic/default usage and component Anatomy
  • rearranged a few sections

I also added a new kind of h2 to this page, which I haven't tried elsewhere: Usage with [some other component]. I think this helps to differentiate the content from what would otherwise fall under Customization, and hopefully makes it easier for users to find. cc @oliviertassinari do you think this pattern would work in the Material UI docs as well?

https://deploy-preview-35152--material-ui.netlify.app/joy-ui/react-alert/

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation component: avatar This is the name of the generic UI component, not the React module! package: joy-ui Specific to @mui/joy labels Nov 14, 2022
@mui-bot
Copy link

mui-bot commented Nov 14, 2022

Messages
📖 Netlify deploy preview: https://deploy-preview-35152--material-ui.netlify.app/

No bundle size changes

Generated by 🚫 dangerJS against 3bc85e0

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.

👍 Approved the Argos detection.

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.

Looks great!

@samuelsycamore samuelsycamore merged commit 1c897f8 into mui:master Nov 15, 2022

{{"demo": "BadgeAvatars.js"}}

### Group
## Usage with the Avatar Group
Copy link
Member

Choose a reason for hiding this comment

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

I think that it would be simpler with:

Suggested change
## Usage with the Avatar Group
## Avatar Group

When I read "Usage with" I head with another component, but the group is part of the same component. Maybe "group" should be lowercase for the same reason.

@oliviertassinari
Copy link
Member

oliviertassinari commented Nov 15, 2022

I also added a new kind of h2 to this page, which I haven't tried elsewhere: Usage with [some other component]. I think this helps to differentiate the content from what would otherwise fall under Customization, and hopefully makes it easier for users to find. cc @oliviertassinari do you think this pattern would work in the Material UI docs as well?

@samuelsycamore On this page, as a user, I think that I would the first 2-3 viewports's height of the page would work better with:

  1. The removal of the ## Component section. I feel that it duplicates with ## Basics. We can move the installation instructions somewhere else, but why not remove them too, there is already an overall getting started area in the section. Developers could find it.

Screenshot 2022-11-15 at 22 26 39

  1. The addition of a simple live demo in

Screenshot 2022-11-15 at 22 26 44

so we don't have to scroll two viewports to find one. As a developer, I would personally never trust what I see in 1. because it doesn't have a preview of what it renders.

@samuelsycamore
Copy link
Member Author

samuelsycamore commented Nov 15, 2022

  1. The removal of the ## Component section. I feel that it duplicates with ## Basics. We can move the installation instructions somewhere else, but why not remove them too, there is already an overall getting started area in the section. Developers could find it.

Whoops! That header is an artifact from the earlier version of the doc. I'll address that and the need for a demo under Basics in #35162. We can discuss whether or not to remove this section entirely on that PR.

the-mgi pushed a commit to the-mgi/material-ui that referenced this pull request Nov 17, 2022
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
feliperli pushed a commit to jesrodri/material-ui that referenced this pull request Dec 6, 2022
@samuelsycamore samuelsycamore deleted the joy-avatar branch April 3, 2024 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: avatar This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants