asdf icon indicating copy to clipboard operation
asdf copied to clipboard

docs: Update core.md with clear explanation on reshim

Open HwangTaehyun opened this issue 1 year ago • 3 comments

Summary

Hi! For asdf beginners, reshim is a bit of a difficult concept at first, so it would be good to have a little more detailed explanation.

npm is usually installed by default when installing a node plugin, and according to the current example, when we do npm install -g yarn, npm itself is included in the asdf plugin lifecycle, so asdf will automatically create a shim for yarn.

For a clear explanation, I changed the docs for reshim to use yarn and pnpm instead of node's package manager npm.

@hyperupcall @jthegedus Could you review it?

Other Information

I'm participating in Hacktoberfest 2024, if the PR makes sense right now, could you add "hacktoberfest-accepted" label? Thanks!

https://hacktoberfest.com/participation/#:~:text=%5Baccepted%5D%20Your%20PR/MRs%20must%20be%20merged%2C%20have%20the%20%E2%80%9Chacktoberfest%2Daccepted%E2%80%9D%20label%2C%20or%20have%20an%20overall%20approving%20review.

HwangTaehyun avatar Oct 06 '24 09:10 HwangTaehyun

Hey! This LGTM, but i'm not a maintainer and I'm no longer contributing to this project

hyperupcall avatar Oct 06 '24 23:10 hyperupcall

@hyperupcall Oh, I see. Thank you!!

HwangTaehyun avatar Oct 07 '24 00:10 HwangTaehyun

@Stratus3D Hi! Could you kindly review it when you have the chance? Thank you in advance for your time and feedback.

HwangTaehyun avatar Oct 08 '24 02:10 HwangTaehyun

Hi @HwangTaehyun , I don't think these changes will significantly improve peoples understanding of the shim concept. Your changes would improve things for JavaScript users, but many users of asdf aren't familiar with the JavaScript ecosystem (myself included). I'm going to close this PR now. Thanks for the PR, and feel free to create another one if you see anything else in the documentation that could be improved.

Stratus3D avatar Dec 17 '24 19:12 Stratus3D