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] Standardize example names #36112

Merged
merged 9 commits into from Feb 15, 2023

Conversation

samuelsycamore
Copy link
Member

This PR standardizes the formatting of example project names in the /examples/ folder. This is mainly to apply standard lib prefixes material-, base-, and joy- for better organization, in anticipation of adding more examples for Base and Joy in the coming months. Framework names drop js, css, etc. to avoid clutter. -ts is appended where applicable.

I also updated the names of projects in READMEs and indexes etc. to specify what tools are involved. Many older examples still refer to Material UI as MUI, so I changed that wherever I saw it. Otherwise I tried not to make too many content changes. Hopefully I caught all links to all examples throughout the docs!

Screenshot 2023-02-08 at 2 52 25 PM

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation examples Relating to /examples labels Feb 8, 2023
@samuelsycamore samuelsycamore requested a review from a team February 8, 2023 21:09
.codesandbox/ci.json Outdated Show resolved Hide resolved
@samuelsycamore samuelsycamore requested a review from a team February 9, 2023 16:26
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 13, 2023
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Feb 13, 2023
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.

Much cleaner! Just one comment

examples/material-vite/README.md Outdated Show resolved Hide resolved
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.

👍 Thanks @samuelsycamore for fixing this!

@samuelsycamore samuelsycamore merged commit 20896a9 into mui:master Feb 15, 2023
@samuelsycamore samuelsycamore deleted the update-example-names branch February 15, 2023 19:06
@oliviertassinari
Copy link
Member

oliviertassinari commented Feb 17, 2023

I have cherry-picked this change to production https://github.com/mui/material-ui-docs/commits/latest as

Screenshot 2023-02-18 at 00 30 13

it breaks the links in the docs, e.g. https://mui.com/material-ui/getting-started/example-projects/. It was reported in https://mui-org.slack.com/archives/C041SDSF32L/p1676634426113669

Screenshot 2023-02-18 at 00 30 53

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 examples Relating to /examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants