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][joy] Improved readability on theme tokens page #35639

Merged
merged 2 commits into from Dec 27, 2022

Conversation

badalsaibo
Copy link
Contributor

@badalsaibo badalsaibo commented Dec 27, 2022

While reading, wanted to navigate quickly b/w these two sections and couldn't do that.
So added that with this PR.

Signed-off-by: badal <14058003+badalsaibo@users.noreply.github.com>
@badalsaibo badalsaibo changed the title Improved readability [docs] [JoyUI] Improved readability on theming Dec 27, 2022
@mui-bot
Copy link

mui-bot commented Dec 27, 2022

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

No bundle size changes

Generated by 🚫 dangerJS against d8b33e0

Comment on lines +7 to +8
1. [Low-level tokens](#low-level-tokens)
2. [Global variant tokens](#global-variant-tokens)
Copy link
Member

Choose a reason for hiding this comment

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

IMO, unordered list is better for this:

Suggested change
1. [Low-level tokens](#low-level-tokens)
2. [Global variant tokens](#global-variant-tokens)
- [Low-level tokens](#low-level-tokens)
- [Global variant tokens](#global-variant-tokens)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi. I gave it a numbered list because of the description clearly mentioning two categories.

to develop its theme, consisting of two categories

An unordered list is also valid if future iterations would make require more than two categories.

Let me know what should I do. 😊

Copy link
Member

Choose a reason for hiding this comment

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

An ordered list should be no problem in this case.

@ZeeshanTamboli ZeeshanTamboli changed the title [docs] [JoyUI] Improved readability on theming [docs][joy] Improved readability on theme tokens docs Dec 27, 2022
@ZeeshanTamboli ZeeshanTamboli added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy customization: theme Centered around the theming features labels Dec 27, 2022
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli left a comment

Choose a reason for hiding this comment

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

Thanks. Left one suggestion. Can you also run yarn prettier and push the formatting changes?

@ZeeshanTamboli ZeeshanTamboli changed the title [docs][joy] Improved readability on theme tokens docs [docs][joy] Improved readability on theme tokens page Dec 27, 2022
Copy link
Member

@hbjORbj hbjORbj left a comment

Choose a reason for hiding this comment

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

Good catch, thanks for your contribution!

@hbjORbj hbjORbj merged commit 7c9bbe5 into mui:master Dec 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customization: theme Centered around the theming features 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