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] Right-to-left revision and addition to Joy UI #39158

Merged
merged 43 commits into from
Jan 4, 2024

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Sep 25, 2023

Closes #37940

This PR revises the Material UI right-to-left guide and adds a version of it to the Joy UI customization guides.

@danilo-leal danilo-leal added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material package: joy-ui Specific to @mui/joy labels Sep 25, 2023
@danilo-leal danilo-leal self-assigned this Sep 25, 2023
@mui-bot
Copy link

mui-bot commented Sep 25, 2023

@danilo-leal danilo-leal marked this pull request as draft September 25, 2023 18:30
@danilo-leal
Copy link
Contributor Author

@samuelsycamore Same as the other ⎯ feel free to drop in and revise the copywriting!

@samuelsycamore
Copy link
Member

Hey @danilo-leal! 👋 I finally got around to reviewing these docs. I've never actually used this feature before, so I had to learn my way around it, and I made some revisions based on things I noticed that were unclear in the earlier drafts. I also removed the JSS sections since we don't generally recommend using those solutions anymore. Let me know what you think! There's one section that I don't totally understand, but I think I need to spend more time with the feature to figure out how it works so I can describe it better!

@danilo-leal danilo-leal marked this pull request as ready for review October 13, 2023 12:09
@danilo-leal
Copy link
Contributor Author

Uhm... in comparison to the Box page, this one seems less fitting to be in the System docs. If you check the two articles, from Material and Joy, there are no System imports... even though, possibly, everything @mui/*/styles comes from System (genuinely not sure). Also, given the instructions to pull this off are not just System-related, I feel like it does make sense for this page to live in each product environment.

@samuelsycamore
Copy link
Member

I don't have a strong opinion either way regarding where these docs live. I think it makes sense to keep these docs for each product for now. Maybe this is another contender for the future companywide docs (#33514) if we ever have the bandwidth to prioritize that! 😅

@danilo-leal
Copy link
Contributor Author

@oliviertassinari hey! Do you mind re-reviewing this one? As you had a "request changes" before, I'll need your approval specifically. 😅

@danilo-leal
Copy link
Contributor Author

@oliviertassinari — little bump on this one. 😃

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 have tried to improve the pages

My take is still that 80% of the content should be in MUI System https://mui.com/system/getting-started/ because nothing is Material UI or Joy UI specific, but these changes here are fair. It's a great step along the way, getting the content right first.

@oliviertassinari oliviertassinari added the enhancement This is not a bug, nor a new feature label Jan 4, 2024
@danilo-leal danilo-leal merged commit 76e8700 into mui:master Jan 4, 2024
22 checks passed
@danilo-leal danilo-leal deleted the rtl-docs-revision-add-joy branch January 4, 2024 11:35
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Jan 9, 2024
Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Co-authored-by: siriwatknp <siriwatkunaporn@gmail.com>
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
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 enhancement This is not a bug, nor a new feature package: joy-ui Specific to @mui/joy package: material-ui Specific to @mui/material
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

[docs][joy-ui] Right-to-left (RTL) text alignment support is undocumented
6 participants