github-actions[bot]
commented
1 month ago This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue. Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.
The problem
The Material UI docs have been written by thousands of people over many years. That's really cool, but there's a very conspicuous lack of an editor's touch. Page structure/formatting is inconsistent, grammar often leaves much to be desired, and there are no style rules applied across the board.
As with #32072 and #33998, I intend to audit and revise each existing page individually to apply our company style guide and best practices for writing documentation.
Scope
This issue is only intended to cover the Component pages in the Material UI docs. Most of the Getting started docs have already been revised over the last year. I'll open separate issues in the future for other sections (How To Guides, Customization, etc.) to keep the scope from being too massive here.
The primary goal is consistency. I'm less concerned with adding new content except where I find major gaps that need to be covered.
I intend to review each page individually. Most pages will get their own PR, but some may be grouped together if the edits are minimal. I'll edit as needed for grammar, style, page formatting, content clarity, and completeness.
This is a very, very big project, so I expect it to be ongoing for awhile. This issue is where we can keep track of the progress.
Pages