yarnpkg / berry

📦🐈 Active development trunk for Yarn ⚒
https://yarnpkg.com
BSD 2-Clause "Simplified" License
7.23k stars 1.07k forks source link

Simplify documentation of "constraints" overview #6257

Closed jeremy-daley-kr closed 2 months ago

jeremy-daley-kr commented 2 months ago

The current documentation overview for Constraints reads somewhat like a sales pitch, rather than documentation. It's a bit wordy, and kind of grammatically incorrect/confusing. It might be more beneficial to mention "enforcement of workspace package rules" as the main point, rather than towards the end of the description. Additionally, constraints can be used for a large number of needs that are not necessarily "basic" ones.

I'd be fine with expanding the example list, but being sure to specify that these are just examples of how constraints are commonly used. They're not the limit of the capability.

What's the problem this PR addresses?

Unclear documentation.

How did you fix it?

Made it a bit more clear and simple.

Checklist