twbs / bootstrap

The most popular HTML, CSS, and JavaScript framework for developing responsive, mobile first projects on the web.
https://getbootstrap.com
MIT License
170.93k stars 78.88k forks source link

Docs: add warning callout for Yarn Berry #41036

Closed julien-deramond closed 8 hours ago

julien-deramond commented 5 days ago

Description

Based on the discussion in https://github.com/twbs/bootstrap/issues/40933 and the solution brought to build our Sass & JS example in https://github.com/twbs/bootstrap/issues/40933#issuecomment-2480946630, this PR suggests a small enhancement to at leasts mention this "trick".

The approach is that we consider that most folks are still on Yarn (Classic), but we mention a way to make our examples work with Yarn Berry too to unblock some others.

Another approach would be to create a dedicated example in twbs/examples and link to it. But, TBH, I don't have time for it, and I'm not sure whether it's needed for now.

Type of changes

Checklist

Live previews

julien-deramond commented 1 day ago

On the content, I tried and it works pretty well, I'm just wondering where it should be placed tbh. Maybe inside the ## Examples paragraph ? It looks weird in here since we only mention the library.

I chose this place because this is the only place where "Yarn" is mentioned. So I'd suppose that Yarn users would end up here at some point.

The rendering looks a bit weird

You mean the code part within the warning callout? FYI, we got the same rendering at https://deploy-preview-41036--twbs-bootstrap.netlify.app/docs/5.3/components/tooltips/#usage