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] Add adjustments to the color inversion page #37143

Merged
merged 12 commits into from
Jul 19, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented May 3, 2023

This PR adds some adjustments to the Joy UI Color inversion page. It includes both some slight copywriting tweaks, as well as information hierarchy and design tweaks (mostly simplifications) to the common examples.

https://deploy-preview-37143--material-ui.netlify.app/joy-ui/main-features/color-inversion/

@danilo-leal danilo-leal added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels May 3, 2023
@danilo-leal danilo-leal changed the title [docs] Add adjustments to the color inversion page [docs][joy] Add adjustments to the color inversion page May 17, 2023
@danilo-leal danilo-leal self-assigned this May 17, 2023
Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Added some copy edits here. I noticed that this page is using the older style of referring to ComponentNames in back ticks so I made suggestions where I noticed them, but we may want to comb through the whole page again to correct any others so it's consistent throughout.

@danilo-leal
Copy link
Contributor Author

@samuelsycamore these look great already, appreciate it! I think we could look back at the Joy docs before its stable launch to refine all of these rough edges 🤙

@mui-bot
Copy link

mui-bot commented May 29, 2023

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against cbeb653

@@ -28,14 +27,14 @@ export default function ColorInversionFooter() {
color={color}
invertedColors
sx={{
...(color !== 'warning' && {
...(color !== 'neutral' && {
bgcolor: `${color}.800`,
}),
flexGrow: 1,
Copy link
Member

@siriwatknp siriwatknp Jun 2, 2023

Choose a reason for hiding this comment

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

@danilo-leal Could we add

…color === 'warning' && {
  bgcolor: 'warning.400',
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Tried locally and it didn't seem to have any effect 😞

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the sake of alignment: I'll merge this PR as soon as it is approved due to the various copywriting & design tweaks and then we can go back to this issue as it seems something isolated 😬

Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Couple tiny edits here, otherwise the text is looking solid!

@danilo-leal
Copy link
Contributor Author

danilo-leal commented Jul 3, 2023

If any of you knows how to help: I've run yarn docs:typescript:formatted twice, which returns "0 demos were unsuccessfully transpiled" but test_types keeps shouting the "Did you run yarn docs:typescript:formatted?". 🤔

(Additionally, the first time I ran it, it picked up other files not originally intended to be part of this PR, like Material & Base demos. Not sure why, really...)

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

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Couple more tiny style & grammar edits here, otherwise I think the content is good to go once the PR is up to date and passing tests. 👍

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 19, 2023
@danilo-leal danilo-leal merged commit 08464e4 into master Jul 19, 2023
24 checks passed
@danilo-leal danilo-leal deleted the joy-color-inversion-docs-tweak branch July 19, 2023 18:34
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
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

None yet

4 participants