[docs-infra] Report component size in the docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99.1k
- Forks
- 32.5k
- Avg merge
- 2d 17h
- Merged PRs (30d)
- 106
Description
Steps to reproduce
Open https://mui.com/base-ui/react-autocomplete/
Current behavior
No information about bundle size.
Expected behavior
By order of how great the solution would be:
- 1. Bundle size information is available for each docs page
- 2. Bundle size information is available for each docs page automatically
- 3. A direct link to a trusted third-party is available (Requiring to fix https://github.com/pastelsky/bundlephobia/issues/389)
Context
I have been dreaming of this since 2019 https://trello.com/c/iLsZLqL3/1978-improve-docs-header. It's an important feature IMHO. When I decide to adopt a new npm package, I would systematically check:
- npm downloads stats
- bundle size
- contribution history
- issues history
Previous conversation: https://github.com/mui/material-ui/pull/33156/files#r897983362
Benchmark
- https://www.radix-ui.com/docs/primitives/components/switch, this is amazing, I feel like this helps gain trust from frontend engineers. It makes us accountable for all the crap bloat features you add to our modules.
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 referenced Autocomplete documentation page, the earlier pull-request discussion, and the Bundlephobia issue to understand the available approaches. Compare them with the Radix UI benchmark, then define which documented bundle-size outcome is achievable; done means the selected bundle-size information or trusted link is available on the relevant docs pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100