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

[docs] Update API design approach guide #35147

Open
oliviertassinari opened this issue Nov 14, 2022 · 1 comment
Open

[docs] Update API design approach guide #35147

oliviertassinari opened this issue Nov 14, 2022 · 1 comment
Labels
docs Improvements or additions to the documentation

Comments

@oliviertassinari
Copy link
Member

oliviertassinari commented Nov 14, 2022

The content of this guide https://mui.com/material-ui/guides/api/ is getting outdated, it's not longer in sync with how we design APIs. We raised in #34895 (comment) that it could be great to update it. The value would be:

  • For MUI
    • To create more consistent APIs
    • To know why specific APIs exist. It's going to be hard two years from now to find the GitHub or Notion pages where we agreed on the given APIs and why. This will avoid making unnecessary changes to how we design APIs because we are missing the full context of the constraints with the current guidelines.
  • For the community
    • To know how best to extend MUI.
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Nov 14, 2022
@flaviendelangle
Copy link
Member

Related to #31745

@oliviertassinari oliviertassinari changed the title [docs] Update API design approach [docs] Update API design approach guide Nov 16, 2022
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
Projects
None yet
Development

No branches or pull requests

2 participants