mui / mui/material-ui

[docs] Revise "Styled library interoperability" doc

Open
#38,147 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

docs scope: all components
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

Batch revisions to https://mui.com/material-ui/guides/interoperability/

  • Update the title: it's very vague as to what the doc is about
  • Update the blurb: “While you can use the Emotion-based ... you can also use the one you already know” sounds like it implies you can replace Emotion with all the things listed here (e.g. Tailwind CSS) which isn't true
  • Improve the visibility of instructions to reverse Emotion's CSS injection order: I think this should be much closer to "Installation" or "Usage". Also wondering if it's possible to restructure the doc so we don't need to repeat the instructions multiple times

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the Styled library interoperability guide at https://mui.com/material-ui/guides/interoperability/ and review its title, introductory blurb, and CSS injection-order instructions. Done means the scope of supported styling approaches is accurate, the reverse-injection guidance is more visible, and repeated instructions are reduced where practical.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react, tailwindcss
Domain
documentation, frontend
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.