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] Revise and update Examples doc #38205

Merged
merged 2 commits into from
Aug 1, 2023

Conversation

samuelsycamore
Copy link
Member

@samuelsycamore samuelsycamore commented Jul 28, 2023

  • updated copy throughout
  • removed suggestion to start with Create React App, replaced with recommendations for Next.js and Vite
  • added suggestion to move on to Templates doc; made MUI Store link more conspicuous
  • reorganized community projects to put CRA examples at the bottom of the list

I've always felt like this doc actually covers two separate topics—boilerplates for framework integration on the one hand, and marketing for community projects on the other. I don't really understand how the two are connected. What do you all think about moving the latter section somewhere else? Should it be its own page, or would it make more sense to relocate that content to Related Projects and/or the Showcase?

https://deploy-preview-38205--material-ui.netlify.app/material-ui/getting-started/example-projects/

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material examples Relating to /examples labels Jul 28, 2023
@mui-bot
Copy link

mui-bot commented Jul 28, 2023

@oliviertassinari
Copy link
Member

I've always felt like this doc actually covers two separate topics—boilerplates for framework integration on the one hand, and marketing for community projects on the other. I don't really understand how the two are connected.

The problem solved is that components on their own aren't enough, you need the infrastructure around them, hence example projects. Now, there are different categories of this. Refine and React Admin are more integrations. The scalefoldhub, divjoy and a few others are more boilerplates. Then, we also have templates.

For example, in the integration category, I talked with @rubenfiszel on how it would be nice to have a link to a link to a Windmill + Material UI integration. The same would apply with Storybook.

Copy link
Contributor

@danilo-leal danilo-leal left a comment

Choose a reason for hiding this comment

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

Looking great!

I think I'd agree with having an equivalent page to this one called "Community projects" but, even though I see the confusion reasoning, staying all on this page does seem to make sense given the projects appear to be relevant for an "I'm starting out" use case? No hard preference on my end at the moment ⎯ your call!

@rubenfiszel
Copy link

Ola, founder of windmill here. We have not had time yet but would love to do a starter kit for using mui with windmill. Let us know what page would be the best to do a PR against once you have a community page :)

@samuelsycamore
Copy link
Member Author

OK, let's go ahead and merge this as is for now, and we can revisit how we share related projects another time. @rubenfiszel please feel free to open a PR on this page following the same format as the other entries here! I think this is a good place for it. 🤝

@samuelsycamore samuelsycamore merged commit 41a42c2 into mui:master Aug 1, 2023
18 checks passed
@samuelsycamore samuelsycamore deleted the update-examples-page branch April 3, 2024 17:24
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 package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants