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

[material-ui][docs] Revise component demo pages for style, grammar, content, and formatting consistency #35158

Closed
10 of 62 tasks
samuelsycamore opened this issue Nov 15, 2022 · 1 comment
Assignees
Labels
docs Improvements or additions to the documentation package: material-ui Specific to @mui/material umbrella For grouping multiple issues to provide a holistic view

Comments

@samuelsycamore
Copy link
Contributor

samuelsycamore commented Nov 15, 2022

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

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Nov 15, 2022
@samuelsycamore samuelsycamore self-assigned this Nov 15, 2022
@samuelsycamore samuelsycamore added the on hold There is a blocker, we need to wait label Sep 5, 2023
@samuelsycamore samuelsycamore changed the title [docs] Revise Material UI Component docs for style, grammar, and formatting consistency [docs][material-ui] Revise Component docs for style, grammar, and formatting consistency Sep 6, 2023
@samuelsycamore samuelsycamore changed the title [docs][material-ui] Revise Component docs for style, grammar, and formatting consistency [material-ui][docs] Revise component demo pages for style, grammar, content, and formatting consistency Dec 1, 2023
@samuelsycamore samuelsycamore added umbrella For grouping multiple issues to provide a holistic view and removed on hold There is a blocker, we need to wait labels Dec 1, 2023
Copy link

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.

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 package: material-ui Specific to @mui/material umbrella For grouping multiple issues to provide a holistic view
Projects
None yet
Development

No branches or pull requests

1 participant