-
-
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] Improve the Base documentation #32072
Comments
After reviewing #32364, I'm starting to notice formatting inconsistencies across these docs that I didn't catch when reviewing individually—for example, some include Once the individual revisions are done, I'll go back for one final pass to clean up all the little details across the board on all of these docs at once. |
Re: this comment from @michaldudak, I am going to move the Unstyled components page to the Base docs and split it up into a few "Getting started" pages. |
Template for re-formatting these pages after the first round of revisions is merged: ## Introduction
## Components API
### Component only content
## Hooks
### Hooks only content |
Note to self: HTML tags like |
Several pages such as the Switch doc mention the shared Similarly, we can link to the section about "Components vs hooks" from the new Usage page on the docs for components that have hook counterparts. |
ClickAwayListener needs to be reverted to its old title for SEO purposes. See: this comment |
We need to come to a consensus about styling component names, and when to refer to a specific component vs its general usage. See: this discussion |
IMO we can use just the capitalized component name without backticks unless we instruct the reader to type it or show how it should look in the code (with angle brackets) - so ButtonUnstyled and I'd keep the backticks whenever we refer to a prop, though. |
The first pass is now complete for all Base docs! 🙌 My next task will be to create a PR that addresses formatting inconsistencies across all of these pages at once. |
There will always be further improvements to make, but I believe that the scope of this Issue has been resolved now that #33156 is merged. |
Make the Base docs comprehensive and compliant with our Style Guide (https://www.notion.so/mui-org/Style-guide-2a957a4168a54d47b14bae026d06a24b).
This is a follow-up to #31414.
Docs to review
Getting started
Installation - [docs] Base Installation style revisions and final review #32483Overview - [docs] Add "Overview" page to Base docs #32310Usage & Customization - [docs] Move, split, and revise "Unstyled components" page #32562Components
Input - [docs] Base Input style revisions and final review #32096Select - [docs] Base Select style revisions and final review #32095Slider - [docs] Base Slider style revisions and final review #32140Menu - [docs] Base Menu style revisions and final review #32097Badge - [docs] Base Badge style revisions and final review #32098Modal - [docs] Base Modal style revisions and final review #32093Form control - [docs] Base Form Control style revisions and final review #32309Table pagination - [docs] Base TablePagination style revisions and final review #32178Trap focus - [docs] Base TrapFocus style revisions and final review #32364Popper - [docs] Base Popper style revisions and final review #32412Tabs - [docs] Base Tabs style revisions and final review #32423No SSR - [docs] Base NoSsr style revisions and final review #32254Click-away listener - [docs] Base ClickAwayListener style revisions and final review #32156Button - [docs] Base Button style revisions and final review #32380Textarea autosize [docs] Base TextareaAutosize style revisions and final review #32481Portal - [docs] Base Portal style revisions and final review #32157Switch - [docs] Base Switch style revisions and final review #32376The text was updated successfully, but these errors were encountered: