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-ui] Revise the CSS vars page #39335

Merged
merged 11 commits into from
Oct 30, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Oct 6, 2023

This one is motivated by a recent docs-feedback where folks have pointed out how the Usage page was saying something inaccurate. After tackling that, it felt like a great opportunity to poke at the CSS vars page and ensure everything was tidy there... Ended up finding this one super hard, though. I'm not fully sure whether the terminology I've used on the page is correct and if it's well-structured. @siriwatknp would appreciate some more technical validation on this one!

👉 https://deploy-preview-39335--material-ui.netlify.app/joy-ui/customization/using-css-variables/

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

mui-bot commented Oct 6, 2023

@danilo-leal
Copy link
Contributor Author

@samuelsycamore — bumping this one up for a quick pass! 😬

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.

Definitely looks better without the Usage header!


Use the `theme.vars.*` notation with any styling APIs supported by Joy UI:

### styled function
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we should links to the relevant docs for each of these sections? This page assumes that the reader knows what all of these are, which may not be the case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added a success callout pointing to the Approaches page — what do you think?

(We might need to do a quick revision on that one, too, to ensure it covers all the styling APIs adequately, as well with demos for them... but for another PR!)

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.

One last thing and then I think it's good to go!

Co-authored-by: Sam Sycamore <71297412+samuelsycamore@users.noreply.github.com>
Signed-off-by: Danilo Leal <67129314+danilo-leal@users.noreply.github.com>
@danilo-leal danilo-leal merged commit 2252a87 into mui:master Oct 30, 2023
19 checks passed
@danilo-leal danilo-leal deleted the css-vars-doc-revision branch October 30, 2023 11:50
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