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 the Menu page #41944

Closed
wants to merge 2 commits into from

Conversation

yassinmars
Copy link

@yassinmars yassinmars commented Apr 17, 2024

This commit updates the menus.md file to improve the clarity and readability of the documentation for the React Menu component in Material-UI. The changes include rephrasing certain sections, providing better explanations, and ensuring consistency in formatting and terminology throughout the document.

The aim of these changes is to make it clearer and easier for developers to understand and utilize the Menu component, as well as to adhere to the guidelines outlined in the Material-UI contribution documentation. The content remains largely unchanged, with only improvements made to enhance comprehension and user experience.

This commit is signed off by [email protected].

This commit updates the menus.md file to improve the clarity and readability of the documentation for the React Menu component in Material-UI. The changes include rephrasing certain sections, providing better explanations, and ensuring consistency in formatting and terminology throughout the document.

The aim of these changes is to make it easier for developers to understand and utilize the Menu component, as well as to adhere to the guidelines outlined in the Material-UI contribution documentation. The content remains largely unchanged, with only improvements made to enhance comprehension and user experience.

This commit is signed off by [email protected].


Signed-off-by: yassinmars <[email protected]>
@mui-bot
Copy link

mui-bot commented Apr 17, 2024

Netlify deploy preview

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 2da0f11

This commit updates the documentation for the Menu Component to improve clarity and consistency. Changes include fixing typos, refining wording for better understanding, and addressing warnings of my last changes reported by the documentation linting tool.

Signed-off-by: yassinmars <[email protected]>
@danilo-leal danilo-leal changed the title Update menus.md [material-ui][docs] Revise the Menu page Apr 17, 2024
@danilo-leal danilo-leal added docs Improvements or additions to the documentation component: menu This is the name of the generic UI component, not the React module! package: material-ui Specific to @mui/material labels Apr 17, 2024
@danilo-leal
Copy link
Contributor

danilo-leal commented Apr 17, 2024

@samuelsycamore quick note: this makes me wonder whether we should make the Style Guide more accessible so we can refer back to it when writing PRs pop up. I guess it could be another piece of content that'd fit the company-wide docs space? I'd be happy to move it over there.

@samuelsycamore
Copy link
Contributor

Hi @yassinmars, thanks for your interest in contributing to the Material UI docs! This PR is not in line with our style guide and doesn't adhere to the current standards for structure and formatting of the component demo pages (#35158). If you'd like to do this kind of editing, I would highly recommend reviewing some of the PRs linked in that umbrella issue to see what the final product should look like. I'm going to close this PR here, but please feel free to reach out to me at sam at mui dot com if you have any questions about contributing to the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: menu This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants