[docs][material-ui] Add a react-admin example project #39972
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Netlify deploy previewhttps://deploy-preview-39972--material-ui.netlify.app/ Bundle size report |
mj12albert
changed the title
danilo-leal
changed the title
danilo-leal
added
docs
| { | ||
| name: 'React-admin', | ||
| label: 'View TS example', | ||
| link: 'https://github.com/mui/material-ui/tree/master/examples/material-ui-react-admin', |
There was a problem hiding this comment.
Can we move the source to another location? I doubt we should maintain this here.
There was a problem hiding this comment.
Maybe this is a silly nitpick, but can we still call this an "official example" if it doesn't live in the MUI core repo? Would it make more sense to be listed under the "community projects"? I know we already have the bullet point for React Admin itself, so maybe this should be linked there instead? (Tangential but this also makes me think we should revisit how the community projects are presented—right now it's a pretty big wall of text.)
There was a problem hiding this comment.
@samuelsycamore I think we should trend toward reworking the whole section.
- "Example projects" as a header doesn't make much sense to me. Instead, it could be "Framework guides", like in https://tailwindcss.com/docs/installation/framework-guides, https://www.tremor.so/docs/getting-started/installation, https://nextui.org/docs/frameworks/nextjs, https://ui.shadcn.com/docs/installation, https://mantine.dev/getting-started/#framework-guide, https://panda-css.com/docs/installation/qwik. Some call it "Integration", e.g. https://reshaped.so/content/docs/getting-started/integrations/tailwind but this a very broad term. I think that in cases like using it with Storybook, icon libraries, etc. it's doesn't need to be part of the getting started area of the docs, these concerns only come later.
- Have a dedicated page for each framework, we started with https://mui.com/joy-ui/integrations/next-js-app-router/, I would scale this to everything. We need both an example and a step-by-step guide on how to create the example. Today, I don't think that we play the step-by-step guide card enough but it's important, when you already have a product on a given framework, you don't want to reverse engineer examples to figure out what to add. This is also true when you are just getting started, and need to rely on two integrations, e.g. Next.js + Tailwind CSS.
- So "Official examples" would go away, I don't think, people care, you already know what's "official" based on where the thing is hosted
- "Community projects" could become its own page.
|
Until you rework the section, can this PR be merged? |
mapache-salvaje
approved these changes
Dec 1, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 1, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 6, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 6, 2023
mnajdova
pushed a commit
to mnajdova/material-ui
that referenced
this pull request
Dec 6, 2023
1 task
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new example to the Getting Started documentation: react-admin.
https://deploy-preview-39972--material-ui.netlify.app/material-ui/getting-started/example-projects/