search

radix-ui / primitives

Radix Primitives is an open-source UI component library for building high-quality, accessible design systems and web apps. Maintained by @workos.
https://radix-ui.com/primitives
MIT License
14.82k stars 717 forks source link

Changelog with breaking changes #2976

Open eps1lon opened 1 week ago

eps1lon commented 1 week ago

Documentation

There is currently no comprehensive changelog for breaking changes e.g. what are the breaking changes in @radix-ui/react-primitive@2.0.0? This makes it hard to upgrade Radix UI packages.

It's also not apparent for users how package names map to the headings in https://www.radix-ui.com/primitives/docs/overview/releases.

Ideally we'd also have GitHub releases and tagged commits so that it is apparent when a change was released. You could automate all of this with Changesets

Related to https://github.com/radix-ui/primitives/issues/2508

Relevant Radix Component(s)

All

Examples from other doc sites

https://github.com/mui/material-ui/releases

vladmoroz commented 1 week ago

There is currently no comprehensive changelog for breaking changes e.g. what are the breaking changes in @radix-ui/react-primitive@2.0.0? This makes it hard to upgrade Radix UI packages.

Internal utilities like this one aren't documented generally—we don't advertise/recommend using them. This one specifically was bumped to major because I removed a type export for a really old React.ComponentPropsWithoutRef workaround.

It's also not apparent for users how package names map to the headings in https://www.radix-ui.com/primitives/docs/overview/releases.

As in, you'd rather see @radix-ui/react-popover instead of Popover? This makes sense

Ideally we'd also have GitHub releases and tagged commits so that it is apparent when a change was released. You could automate all of this with Changesets

Strongly agree. I don't know when we'd find time to set this up, but it's on our radar.

eps1lon commented 1 week ago

Internal utilities like this one aren't documented generally—we don't advertise/recommend using them. This one specifically was bumped to major because I removed a type export for a really old React.ComponentPropsWithoutRef workaround.

Good to know, thank you. Is it safe to assume that every package that's not used in the docs is internal?

vladmoroz commented 1 week ago

Good to know, thank you. Is it safe to assume that every package that's not used in the docs is internal?

Yep exactly