Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

doc: improve Download section of README #23212

Closed
wants to merge 4 commits into from
Closed

doc: improve Download section of README #23212

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
400ce40
doc: improve Download section of README
Trott Oct 2, 2018
094ec84
!suggestion!
refack Oct 2, 2018
482ecb0
fixup
refack Oct 2, 2018
f21f5b4
!suggestion! edit
refack Oct 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,23 +100,27 @@ Binaries, installers, and source tarballs are available at
<https://nodejs.org/en/download/>.

#### Current and LTS Releases
**Current** and **LTS** releases are available at
<https://nodejs.org/download/release/>, listed under their version strings.
<https://nodejs.org/download/release/>

The [latest](https://nodejs.org/download/release/latest/) directory is an
alias for the latest Current release. The latest LTS release from an LTS
line is available in the form: latest-_codename_. For example:
<https://nodejs.org/download/release/latest-argon>.
alias for the latest Current release. The latest-_codename_ directory is an
alias for the latest release from an LTS line. For example,
<https://nodejs.org/download/release/latest-carbon> is the latest Carbon
(Node.js version 8) release.

#### Nightly Releases
**Nightly** builds are available at
<https://nodejs.org/download/nightly/>, listed under their version
string which includes their date (in UTC time) and the commit SHA at
the HEAD of the release.
<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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo appeded -> appended with.

Copy link
Member

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack.


#### API Documentation
**API documentation** is available in each release and nightly
directory under _docs_. <https://nodejs.org/api/> points to the API
documentation of the latest stable version.
<https://nodejs.org/api/>

Points to the API documentation of the latest LTS release.
Copy link
Member

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. sorry.

Version specific documentation are avalible in each release and nightly
directory under _docs_.
Copy link
Member

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/?



### Verifying Binaries

Expand Down