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.

Sign up for GitHub

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

Jump to bottom

[docs] Add stray Joy UI documentation improvements #36921

Merged
merged 5 commits into from
Apr 25, 2023
Merged

[docs] Add stray Joy UI documentation improvements #36921

merged 5 commits into from
Apr 25, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Apr 18, 2023 •
edited
Loading

This PR tweaks almost every currently available Joy UI page. They're all simple changes, though, and mostly on the Markdown files. Generally, I'm just going for tiny style fixes, light copywriting updates, and overall formatting refinement. Some of the trends I've identified that got me thinking and interested in opening this PR:

  1. I think we use way too many callouts, there's a lot of them on some pages.
  2. There are a few cases where we introduce sections⎯with a callout⎯that are just a couple of lines away.
  3. Some components had the "learn how to extend the variants" callout but others didn't. I removed some of them, for now. It's valuable information we should probably append consistently in the "Variants" section.
  4. Placement of the extra info chips below the introduction demo. I moved them all to be above it so that, once we introduce tabs in the Joy docs as well, it's a smoother transition.

@danilo-leal danilo-leal added docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy labels Apr 18, 2023
danilo-leal
danilo-leal commented Apr 18, 2023
View reviewed changes
docs/data/joy/customization/using-css-variables/using-css-variables.md
});
```

4. The `useTheme` hook.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do we have a code snippet to in here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@siriwatknp let me know if you have anything we could add here! Additionally, I haven't found any useTheme specific documentation I could've linked here either 🤔

@mui-bot
Copy link

mui-bot commented Apr 18, 2023 •
edited
Loading

Netlify deploy preview

Bundle size report

No bundle size changes

Generated by 🚫 dangerJS against 547d821

@danilo-leal
Copy link
Contributor Author

@siriwatknp mind taking a look here?

samuelsycamore
samuelsycamore approved these changes Apr 24, 2023
View reviewed changes
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.

Solid improvements!

siriwatknp
siriwatknp approved these changes Apr 25, 2023
View reviewed changes
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.

👍 Ship it!

@siriwatknp siriwatknp merged commit b2b5c78 into master Apr 25, 2023
@siriwatknp siriwatknp deleted the joy-stray-doc-improvements branch April 25, 2023 03:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@siriwatknp siriwatknp siriwatknp approved these changes

@samuelsycamore samuelsycamore samuelsycamore approved these changes

Assignees
No one assigned
Labels
docs Improvements or additions to the documentation package: joy-ui Specific to @mui/joy
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@danilo-leal @mui-bot @siriwatknp @samuelsycamore