Nothing should link to `npx` package on www.npmjs.com
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 711
- Forks
- 4.2k
- Avg merge
- 4d 16h
- Merged PRs (30d)
- 3
Description
I just opened https://github.com/npm/cli/pull/5742 and https://github.com/npm/documentation/pull/277.
Searching Google for "npx" brings up:
https://www.npmjs.com/package/npx
... as the first result. The "best link", the npx CLI command entry in the npm docs isn't in the first page of results (it's the 1st result on the 2nd page).
https://www.npmjs.com/package/npx is a bit cryptic. Following the link to GitHub goes to:
https://github.com/npm/npx
... which shows:
This repository has been archived by the owner. It is now read-only.
... up top. Scrolling down reveals:
⚠️ DEPRECATED: This project has been deprecated - npx is now part of the npm cli
... that leads to:
https://github.com/npm/cli
The sidebar gives the link to:
https://docs.npmjs.com/cli/
... and then you have to search for "npx" (or drill down into "CLI Commands"), and then finally, you get to:
https://docs.npmjs.com/cli/commands/npx
I'm not sure what can be done to improve this user experience, any ideas?
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 by reviewing the cited npm package page, the archived github.com/npm/npx repository, and the npm documentation links in the issue. Identify every documentation reference that points to the deprecated package and replace or redirect it to the npx CLI command documentation; done means users reach the current docs without passing through the archived project.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100