Repository navigation
Need change in the read me file #24872
Description
Activity
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?Reacted by Tibin Thomas and Anithabalufwiw: my code evaluates at run-time in the node.js runtime
Reacted by Gary Crye and David CARLIERAs 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.
Reacted by AnithabaluI 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
Reacted by Tibin ThomasNothing 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
Reacted by Thomas Watson, Csaba Palfi, Tibin Thomas, Waleed Ashraf and Michael DawsonSo as a result, we should just cut down the later sentence
built on Chrome's V8 JavaScript engineright ?
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 engineis 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.
Reacted by Gireesh PunathilWhat is wrong with simply
Node.js is an open-source, cross-platform runtime environment that executes JavaScript code outside of a browser.
Reacted by Owen Buckley and Michael DawsonWhat 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.
- added a commit that references this issue
on Jan 9, 2020 - added a commit that references this issue
on Jan 11, 2020 - added a commit that references this issue
on Jan 16, 2020 - added 2 commits that reference this issue
on Mar 14, 2020
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.?