Npm install documentation missing actual installation instruction commands
Open
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 712
- Forks
- 4.2k
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 3
Description
Problem:
- Missing instructions on how to get an actual version of NPM working on the landing page
- Multiple levels of indirection when trying to set-up NPM is a rather bad pattern.
Proposal
Update the landing page with the instructions from the github repo on how to get NVM install and how to get NPM installed after that so they are on the same page.
Similarly, update the NodeInstaller instructions to be on the same page.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the landing page section linked in the issue and review the referenced GitHub repository for the NVM and npm setup instructions. Update the landing page so the installation commands are available without multiple levels of indirection, and place the NodeInstaller instructions on the same page. Verify that both installation paths are complete and consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100