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][material-ui][joy-ui] Simplify the Quickstart section on the Usage page #38385

Merged
merged 4 commits into from
Aug 9, 2023

Conversation

danilo-leal
Copy link
Contributor

@danilo-leal danilo-leal commented Aug 8, 2023

From the series of "just browsing around looking for improvement opportunities", I realized we could be simpler and more polished on the Quickstart section of the Usage pages now that the documentation code snippets are editable. Given that wasn't the case previously, we had a Code Sandbox iframe which always looked a bit clunky, their UI clashes a bit with the docs, I think. Figured it'd be much cleaner with a built-in demo. Also, took the liberty to simplify the copy a lot, too!

@danilo-leal danilo-leal added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Aug 8, 2023
@danilo-leal danilo-leal self-assigned this Aug 8, 2023
@danilo-leal danilo-leal changed the title [docs][material-ui] Simplify the Quickstart section on the Usage page [docs][material-ui][joy-ui] Simplify the Quickstart section on the Usage page Aug 8, 2023
@danilo-leal danilo-leal added the package: joy-ui Specific to @mui/joy label Aug 8, 2023
@mui-bot
Copy link

mui-bot commented Aug 8, 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.

Good idea! Just a little copy nitpick here!

docs/data/joy/getting-started/usage/usage.md Outdated Show resolved Hide resolved
docs/data/material/getting-started/usage/usage.md Outdated Show resolved Hide resolved
@danilo-leal danilo-leal merged commit a030925 into master Aug 9, 2023
24 checks passed
@danilo-leal danilo-leal deleted the simplify-material-ui-usage branch August 9, 2023 19:19
@oliviertassinari
Copy link
Member

oliviertassinari commented Aug 29, 2023

Could we remove the Usage.js files? there are still in the codebase. Thanks


Given that wasn't the case previously, we had a Code Sandbox iframe which always looked a bit clunky, their UI clashes a bit with the docs, I think.

Regarding the history, the purpose of the CodeSandbox was also to: 1. show how it just works in isolation (which npm package, which provider, etc.), 2. allow people to share the component with their team. But fair enough, it's cleaner this way, and hopefully new developers will notice:

Screenshot 2023-08-29 at 14 42 44

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 package: material-ui Specific to @mui/material
Projects
Status: Recently completed
Development

Successfully merging this pull request may close these issues.

None yet

4 participants