-
-
Notifications
You must be signed in to change notification settings - Fork 32.4k
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] Add "Overview" page to Base docs #32310
[docs] Add "Overview" page to Base docs #32310
Conversation
@material-ui/core: parsed: +Infinity% , gzip: +Infinity% |
Co-authored-by: danilo leal <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉
Should we add a note to the page to let folks know that Base in currently in alpha? That would also give us another excuse to ask for contributions :) |
Yes please :) |
I like it! It is a gentle introduction to the Base library. FYI, some time ago I created a page in Material UI docs called Unstyled components. It doesn't belong to Material anymore and we should move it. There are more in-depth parts there (such as the anatomy of a component), so it could live as a separate page in Base docs. Please take a look if maybe some of the content (like use cases) could be appropriate for the page you created. |
Thanks for the heads up @michaldudak! There's a lot of useful content there. I think we should move it over to the Base "Getting Started" docs and maybe split up the content into a couple of separate pages. I'll create a new PR for that. |
This PR is in response to issue #32275, adding an Overview page to the Base docs.
https://deploy-preview-32310--material-ui.netlify.app/base/getting-started/overview/
The purpose of this page is to introduce the user to Base and briefly explain why they'd want to use it over Material UI, since I assume the vast majority of users will be familiar with Material UI if they're interested in Base.
This PR can also serve as a first step towards building out a marketing page for Base (in a future PR). Here we can start to formulate the language we want to use to describe Base as a product.
I think this page should be the default landing page for the Base docs, but I'm not sure how to make that happen. 😅
This is my first attempt to add a new page, so I apologize if I missed some piece of the puzzle!
Is there anything else about Base that we should mention in this doc?
It's kind of dry as just a big block of text. Some kind of screenshot would be nice, but that might not make sense for a product that's all about being style-free. 😛
It also feels like it doesn't "lead" anywhere. Maybe the end of the doc should direct the reader to move on to the installation page?