-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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: improve Download section of README #23212
Conversation
Simplify and clarify text in the Download section of the README file.
README.md
Outdated
documentation of the latest stable version. | ||
<https://nodejs.org/api/> | ||
|
||
Points to the API documentation of the latest LTS release. |
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.
This currently points to Node.js v10.11.0 docs, which is the latest current release, so I don't think it's correct to say it points to the latest LTS release.
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.
Yes. sorry.
README.md
Outdated
|
||
Points to the API documentation of the latest LTS release. | ||
Version specific documentation are avalible in each release and nightly | ||
directory under _docs_. |
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.
Replace _docs_
with https://nodejs.org/download/docs/?
README.md
Outdated
<https://nodejs.org/download/nightly/> | ||
|
||
Release names are appeded a version string that includes the date (in UTC time) | ||
and the 10 first characters of the commit SHA at the HEAD of the release. |
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.
Typo appeded
-> appended with
.
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.
On reflection I think I prefer the original text. The reworded text is a little more awkward to read and adds more technical specifics for no added value.
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.
Ack.
Landed in cd40d7a |
Simplify and clarify text in the Download section of the README file. PR-URL: nodejs#23212 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Simplify and clarify text in the Download section of the README file. PR-URL: #23212 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Simplify and clarify text in the Download section of the README file. PR-URL: #23212 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Simplify and clarify text in the Download section of the README file.
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes