-
Notifications
You must be signed in to change notification settings - Fork 14.5k
Update npm.md #29474
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Update npm.md #29474
Conversation
Added in the Additional resources What is npx? Difference between npm and npx
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it makes sense to have these in the npm lesson because npx doesn't get mentioned anywhere. The first time the difference between npm and npx gets mentions is in Revisiting Webpack and the end of the npm.script section already explains that "npx" was only needed before to run the packages locally without an npm script (hence they're dropped in the scripts).
I wonder what the team think, but I feel that doesn't really need diving much further into npx or the difference between the two.
If there is value in linking a resource about the difference, I think something short, simple and accurate (the geekforgeeks article has an error in its example about the npm scripts and how you run them) should be linked inline with the lesson explanation, as opposed to being an additional resource. The npm docs on npx don't feel particularly helpful at this stage and would likely confuse people more or send people down rabbit holes IMO.
That makes sense! I see now that npx isn’t mentioned in this lesson, and its explanation comes later in the curriculum. I agree that adding these links here might not be the best fit. If the team thinks it's valuable, I’d be happy to contribute a more concise and accurate resource in the relevant section instead. Would it make sense to add these links to the Revisiting Webpack lesson under Additional Resources, since that's where the difference between npm and npx is first mentioned? Thanks for the clarification! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking the time to make this PR, and my apologies for the delay in my review.
I think that a quick (like 1-2 sentence) call out directly in the lesson to say from a high level what npx is would make sense, but I don't think these additional resources are a great fit.
Would you want to write something like that?
Thank you for your reply — I really appreciate it!
You're absolutely right—adding a brief, high-level explanation of what is
directly in the lesson makes more sense. I’ll revise the content
accordingly and hope I can add value to the Odin Project.
Thanks again for the feedback!
…On Mon, May 12, 2025 at 7:17 PM Austin Sullivan ***@***.***> wrote:
***@***.**** requested changes on this pull request.
Thanks for taking the time to make this PR, and my apologies for the delay
in my review.
I think that a quick (like 1-2 sentence) call out directly in the lesson
to say from a high level what npx is would make sense, but I don't think
these additional resources are a great fit.
Would you want to write something like that?
—
Reply to this email directly, view it on GitHub
<#29474 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BE3LYIR64WNQVSGNAYMZK7T26CUPJAVCNFSM6AAAAABYFD3IP2VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDQMZTGQYDQMJSGM>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
Added in the Additional resources
What is npx?
Difference between npm and npx
Because
This PR adds useful resources to the "Additional Resources" section of the lesson. The links cover:
These topics help learners understand the purpose and usage of npx and how it differs from npm.
This PR
Added two new links in the "Additional Resources" section:
This improves the lesson by providing external references for deeper understanding.
Issue
This PR does not close an existing issue but enhances the curriculum by adding helpful resources.
Additional Information
No further discussions needed. Just an improvement to the Additional Resources section.
Pull Request Requirements
location of change: brief description of change
format, e.g.Intro to HTML and CSS lesson: Fix link text
Because
section summarizes the reason for this PRThis PR
section has a bullet point list describing the changes in this PRIssue
section