search

emulsify-ds / documentation

Documentation for the Emulsify Design System
https://docs.emulsify.info
7 stars 7 forks source link

Edit compound install to use main branch #42

Closed amazingrando closed 1 year ago

amazingrando commented 1 year ago

Summary

This PR updates the Compound installation commands to use the main branch instead of a specific release version. This outdated information was flagged by @ccjjmartin in the Emulsify Slack.

How to review this PR

ccjjmartin commented 1 year ago

@amazingrando This works, and this is what I would recommend. My reasons for this are in the Slack thread: https://emulsify.slack.com/archives/C4575Q30T/p1665089012757099

Recap: We don't support old versions and never have on this project, anything other than the latest code shouldn't be used. If we support pulling updates from compound in the future we can re-evaluate branches / tags / etc at that point but we don't support pulling updates right now. Not updating these docs is forcing every new install to use the 1.1.0 tag as opposed to the latest (currently 1.6.1). On my new project that I just setup I used the 1.6.1 tag so I would expect that other users across the internet also want to use the 1.6.1 tag. These docs need to be updated in one way or another even if it isn't main that it gets updated too. So for that reason I am reopening the PR (discussion) here.