Skip to content

Conversation

ariansj01
Copy link

@ariansj01 ariansj01 commented Oct 6, 2025

Goal: Improve clarity and consistency in the Card documentation through small, low-risk text edits.
Changes:

Standardize component names in the introduction (CardContent, CardHeader, CardMedia, CardActions, CardActionArea).

Ensure brand consistency: “Material UI” → “MUI”.

Fix minor grammar issues: e.g., “Often a card allow…” → “Often a card allows…”, add missing commas.

Add a short API link after the main header.

Add a brief accessibility note under Media, encouraging proper alt text when using component="img".
Scope: Text-only edits in docs/data/material/components/cards/cards.md; no structural or API changes.

ariansj01 and others added 2 commits October 6, 2025 14:28
…; add best practices, composition, and theming sections; enhance accessibility guidance
@mui-bot
Copy link

mui-bot commented Oct 6, 2025

Netlify deploy preview

Bundle size report

Bundle Parsed size Gzip size
@mui/material 0B(0.00%) 0B(0.00%)
@mui/lab 0B(0.00%) 0B(0.00%)
@mui/system 0B(0.00%) 0B(0.00%)
@mui/utils 0B(0.00%) 0B(0.00%)

Details of bundle changes

Generated by 🚫 dangerJS against 4704224

@zannager zannager added docs Improvements or additions to the documentation. scope: badge Changes related to the badge. labels Oct 6, 2025
@zannager zannager requested a review from brijeshb42 October 6, 2025 13:48
@ariansj01
Copy link
Author

Hey @zannager @brijeshb42 @oliviertassinari 👋
I’ve finished polishing the docs for the Card and Badge component.
Could you please review when you have a moment?
Let me know if there’s anything else to adjust 🙂

@ariansj01 ariansj01 changed the title docs(badge): improve Badge docs clearer intro, API link, UX notes, best practices, theming, a11y docs: unify writing style and polish component intros (Badge, Card) Oct 8, 2025
@ZeeshanTamboli ZeeshanTamboli added the scope: card Changes related to the card. label Oct 13, 2025
Copy link
Contributor

@mapache-salvaje mapache-salvaje left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @ariansj01 ! I appreciate your interest in making improvements to the Material UI docs. However, many of the changes here are incorrect (for example, MUI and Material UI are not synonymous) or do not align with our style guide and best practices (for example, we avoid latinisms such as "e.g." when adding to or editing the docs). As such, I can't really offer a review and am going to close this.

To improve your chances of getting a docs PR reviewed, here's what I recommend:

Another great way to get involved is to search for the docs tag on open issues and see if there's anything you're interested in working on - this way you know you'll be solving a concrete problem that's already been identified.

Hope this helps!

@ariansj01
Copy link
Author

Thank you very much for the detailed feedback and clarification!
I completely understand I’ll review the style guide and component conventions more carefully next time.
For my next contribution, I’ll start by opening an issue to propose the doc improvements and keep the scope to one component per PR.
I really appreciate your time and guidance 🙏

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. scope: badge Changes related to the badge. scope: card Changes related to the card.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants