From 4be48b19cb7072f5d102734a9c1986c80696c959 Mon Sep 17 00:00:00 2001 From: Jason Marsh Date: Wed, 1 Mar 2017 08:45:01 -0600 Subject: [PATCH 1/2] Table of Contents and Relative Links I have added a TOC to the top of the readme, relative links to allow jumping to the appropriate section of the readme. --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 7fe05e05e27ad0..2b54ea2e324ed1 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,29 @@ policies, and releases are managed under an If you need help using or installing Node.js, please use the [nodejs/help](https://github.com/nodejs/help) issue tracker. + +# Table of Contents + +* [Resources for Newcomers](#resources-for-newcomers) + * [Official Resources](#official-resources) + * [Website](https://nodejs.org/en/) + * [Node.js Help](https://github.com/nodejs/help) + * [Contributing to the project](CONTRIBUTING.md) + * [IRC (node core development)](https://webchat.freenode.net/?channels=node-dev&uio=d4) + * [Unofficial Resources](#unofficial-resources) +* [Release Types](#release-types) + * [Download](#download) + * [Current and LTS Releases](#current-and-lts-releases) + * [Nightly Releases](#nightly-releases) + * [API Documentation](#api-documentation) + * [Verifying Binaries](#verifying-binaries) +* [Building Node.js](#building-nodejs) + * [Security](#security) + * [Current Project Team Members](#current-project-team-members) + * [CTC (Core Technical Committee)](#ctc-core-technical-committee) + * [Collaborators](#collaborators) + * [Release Team](#release-team) + ## Resources for Newcomers ### Official Resources @@ -69,6 +92,7 @@ The Node.js project maintains multiple types of releases: Binaries, installers, and source tarballs are available at . +#### Current and LTS Releases **Current** and **LTS** releases are available at , listed under their version strings. The [latest](https://nodejs.org/download/release/latest/) directory is an @@ -76,11 +100,13 @@ alias for the latest Current release. The latest LTS release from an LTS line is available in the form: latest-_codename_. For example: +#### Nightly Releases **Nightly** builds are available at , listed under their version string which includes their date (in UTC time) and the commit SHA at the HEAD of the release. +#### API Documentation **API documentation** is available in each release and nightly directory under _docs_. points to the API documentation of the latest stable version. From 3cf499ea40d057e2ca8597d90c9446a2e2965630 Mon Sep 17 00:00:00 2001 From: Jason Marsh Date: Mon, 27 Mar 2017 10:34:22 -0500 Subject: [PATCH 2/2] docs: Revised TOC Remove repetitious links in "Resources for Newcomers" in TOC --- README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/README.md b/README.md index 2b54ea2e324ed1..92c0805b1a222c 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,6 @@ If you need help using or installing Node.js, please use the # Table of Contents * [Resources for Newcomers](#resources-for-newcomers) - * [Official Resources](#official-resources) - * [Website](https://nodejs.org/en/) - * [Node.js Help](https://github.com/nodejs/help) - * [Contributing to the project](CONTRIBUTING.md) - * [IRC (node core development)](https://webchat.freenode.net/?channels=node-dev&uio=d4) - * [Unofficial Resources](#unofficial-resources) * [Release Types](#release-types) * [Download](#download) * [Current and LTS Releases](#current-and-lts-releases)