[docs] Update API design approach guide
Open
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
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 https://github.com/mui/material-ui/issues/34895#issuecomment-1304205535 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API design guide at https://mui.com/material-ui/guides/api/ and the discussion in issue #34895, especially the linked comment. Compare the guide with the current API design practices described in the repository, then update it so the guidance reflects current decisions and explains their context for MUI contributors and users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100