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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Revise Joy UI "Overview" page copy #34087

Merged
merged 6 commits into from Sep 1, 2022

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Aug 26, 2022

https://deploy-preview-34087--material-ui.netlify.app/joy-ui/getting-started/overview/

Part of #33998.

This PR revises the copy on the Joy UI Overview page. It was already in good shape to begin with, but I saw some opportunities to sharpen it further so I couldn't help myself. 馃槄 I tried to do some reshaping to bring the voice and formatting closer to what we've got for Material UI and Base.

We're still in the early stages of figuring out the "elevator pitch" for Joy UI, so I've tried introducing some unique angles to help differentiate it from Material UI et al. and start to pin down the language we want to use to describe it going forward.

One thing I noticed is that the page titles in the Joy UI docs just say "MUI" where other products actually state their name:
Screen Shot 2022-08-26 at 4 47 54 PM

I'm not sure where these titles are appended in the code, but I'd like to see consistency on the Joy UI side. Maybe @siriwatknp could tell me where that's at?

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Aug 26, 2022
@samuelsycamore samuelsycamore changed the title [docs] Revise Joy UI "Getting started" page copy [docs] Revise Joy UI "Overview" page copy Aug 26, 2022
@mui-bot
Copy link

mui-bot commented Aug 26, 2022

No bundle size changes

Generated by 馃毇 dangerJS against 76dd7ff

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'd like to see consistency on the Joy UI side

Fixed in this PR (though I should probably have opened a new PR but this PR is still small 馃槆)

docs/data/joy/getting-started/overview/overview.md Outdated Show resolved Hide resolved
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.

馃憤 Kudo @samuelsycamore

@samuelsycamore samuelsycamore merged commit b7824f8 into mui:master Sep 1, 2022
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
@samuelsycamore samuelsycamore deleted the joy-getting-started branch April 3, 2024 17:23
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 package: joy-ui Specific to @mui/joy
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants