-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
doc: add npm link to Readme, general cleanup #7769
Conversation
README.md missing npm link removed unnecessary comma formatted links for consistency and readability
* [Website](https://nodejs.org/en/) | ||
* [Contributing to the project](./CONTRIBUTING.md) | ||
* Website: [nodejs.org](https://nodejs.org/en/) | ||
* Project Contributing: [CONTRIBUTING.md](./CONTRIBUTING.md) |
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 am not a native English speaker, but «Project Contributing» does sound a little suspicious to me.
/cc @nodejs/documentation
removed unnecessary comma formatted links for consistency and readability
@@ -5,8 +5,8 @@ Node.js | |||
|
|||
Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. Node.js | |||
uses an event-driven, non-blocking I/O model that makes it lightweight and | |||
efficient. The Node.js package ecosystem, npm, is the largest ecosystem of open | |||
source libraries in the world. | |||
efficient. The Node.js package ecosystem [npm](https://github.com/npm/npm), |
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.
The comma before npm
should not be removed.
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.
Maybe the link should rather go to https://www.npmjs.com/?
Thanks @ChALkeR updated based on your feedback |
@@ -19,8 +19,8 @@ If you need help using or installing Node.js, please use the | |||
|
|||
## Resources for Newcomers | |||
|
|||
* [Website](https://nodejs.org/en/) | |||
* [Contributing to the project](./CONTRIBUTING.md) | |||
* Website: [nodejs.org](https://nodejs.org/en/) |
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 know this wasn't part of this PR, but does anyone know why we are sending everyone to /en
?
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.
Ref: #6681, /cc @Fishrock123.
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.
No reason, it was a copy-paste of what the default is.
This should be fixed.
npm link lgtm but I'm not sure about the other stuff and I would rather keep the newcomer links not verbose. |
LGTM either way once the |
How about just as: |
Nitpick (ignore if you wish) but I believe a trailing slash is more correct here:
|
Updated based on feedback |
Ready to go? @Fishrock123 @cjihrig @Trott @ChALkeR |
LGTM. |
Sorry to ask again, but could you rebase this? |
I have closed this PR for a single commit branched from current master: |
Checklist
Affected core subsystem(s)
doc
Description of change
README.md missing npm link
formatted links for consistency and readability