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

[zero][docs] Add a Why section on the README #41284

Merged
merged 13 commits into from
Mar 4, 2024

Conversation

danilo-leal
Copy link
Contributor

Here's an attempt at explaining to the community the reason why we're investing in this endeavor. As we get close to launching this, stressing the "why does this exist" question is more and more relevant. We can break this down and expand this way more in the future (with comparisons about how it's different from similar libraries A, B, C, etc.), but something high-level for now would potentially suffice!

Let me know if what I'm proposing makes sense or if there's anything y'all would remove or add.

@danilo-leal danilo-leal added docs Improvements or additions to the documentation package: pigment-css Specific to @pigment-css/* labels Feb 26, 2024
@danilo-leal danilo-leal self-assigned this Feb 26, 2024

This comment was marked as resolved.

@mui-bot
Copy link

mui-bot commented Feb 26, 2024

Netlify deploy preview

https://deploy-preview-41284--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against 6bc0cf6

packages/zero-runtime/README.md Outdated Show resolved Hide resolved
packages/zero-runtime/README.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 1, 2024
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Mar 1, 2024
Copy link
Member

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

I've added some suggestions, but overall I feel like this addition is too "we"-centric. The average user really doesn't care about us and our journey to arrive at this solution—they just want to know how it would benefit them to adopt it. ("What's in it for me?") Let me take a shot at rewriting this from scratch to see if I can make it sharper. I'll follow up shortly.

packages/pigment-react/README.md Outdated Show resolved Hide resolved
packages/pigment-react/README.md Outdated Show resolved Hide resolved
packages/pigment-react/README.md Outdated Show resolved Hide resolved
@danilo-leal
Copy link
Contributor Author

@brijeshb42 & @siriwatknp bump here!

@danilo-leal danilo-leal merged commit 15fe702 into mui:master Mar 4, 2024
19 checks passed
@danilo-leal danilo-leal deleted the zero-css-add-a-why-section-readme branch March 4, 2024 19:44
mnajdova pushed a commit to mnajdova/material-ui that referenced this pull request Mar 8, 2024
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: pigment-css Specific to @pigment-css/*
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants