Node: Need change in the read me file

Created on 6 Dec 2018  路  13Comments  路  Source: nodejs/node

Could we change the sentence Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine. to Node.js is a JavaScript run-time that is built on Chrome's V8 JavaScript engine.?

doc good first issue

Most helpful comment

Nothing whatsoever against V8, but I question whether it is sufficiently relevant to the average user such that it warrants mention in the very first paragraph. I'd be fine with:

Node.js is a JavaScript runtime.  For more information on using Node.js, see the
[Node.js Website][].

Stuff about V8, libuv, and whatever else can be delayed until later in the doc or in material linked from the doc.

By the way, the same "built on" stuff appears at the top of the current website, which may be where many more people read/see it than in the README in this repo. @nodejs/website

All 13 comments

You're proposing s/runtime/run-time/? Note that our documentation overwhelmingly favors "runtime", no dash.

IMHO, the sentence at present is appropriate enough, I don't think we need to change that.

The suggestion is also adding that is, which sounds like it might indeed make things a bit easier to understand for non-native speakers?

fwiw: my code evaluates at run-time in the node.js runtime

As a non-native speaker, it took me a while to really understand what the definition of Node really meant..

I think it is very important to give a definition that can also be understood by a non native speaker.

I too got confused while reading it for the first time, it sounded weired. Definitely, adding a definition to it will help many people to understand it quickly

Nothing whatsoever against V8, but I question whether it is sufficiently relevant to the average user such that it warrants mention in the very first paragraph. I'd be fine with:

Node.js is a JavaScript runtime.  For more information on using Node.js, see the
[Node.js Website][].

Stuff about V8, libuv, and whatever else can be delayed until later in the doc or in material linked from the doc.

By the way, the same "built on" stuff appears at the top of the current website, which may be where many more people read/see it than in the README in this repo. @nodejs/website

So as a result, we should just cut down the later sentence built on Chrome's V8 JavaScript engine right ?
And if we came to an agreement, I'm willing to make the change on both the README in this repo and the website.

built on Chrome's V8 JavaScript engine is an implementation detail IMO.

what is the take on this?

The English-language Wikipedia article for Node.js has this as the first sentence at this time:

Node.js is an open-source, cross-platform, JavaScript runtime environment that executes JavaScript code outside of a browser.

The use of JavaScript twice in the sentence is awkward, but I do wonder if that contains more useful and straightforward information than our current lead sentence in the README. Maybe we could modify it to be two sentences:

Node.js is an open-source, cross-platform, JavaScript runtime environment. It executes JavaScript code outside of a browser.

What is wrong with simply

Node.js is an open-source, cross-platform runtime environment that executes JavaScript code outside of a browser.

What is wrong with simply

Node.js is an open-source, cross-platform runtime environment that executes JavaScript code outside of a browser.

I find the two-sentence construction easier to read, but that's just my opinion. The above would be fine too.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jonathanong picture jonathanong  路  91Comments

TazmanianDI picture TazmanianDI  路  127Comments

VanCoding picture VanCoding  路  204Comments

benjamingr picture benjamingr  路  135Comments

aduh95 picture aduh95  路  104Comments