From bd895af1f8509d472c7258f3dfe7c3e1aa9334b3 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 15 May 2019 20:24:21 -0700 Subject: [PATCH] doc: rewrite "About this Documentation" section Replace the "About this Documentation" section with a simple welcome message and a concise description of Node.js PR-URL: https://github.com/nodejs/node/pull/27725 Reviewed-By: Trivikram Kamat Reviewed-By: Anna Henningsen --- doc/api/documentation.md | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/doc/api/documentation.md b/doc/api/documentation.md index d32af91a023..612b6f2dbf5 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -3,13 +3,9 @@ -The goal of this documentation is to explain the Node.js -API, both from a reference as well as a conceptual point of view. Each -section describes a built-in module or high-level concept. +Welcome to the official API reference documentation for Node.js! -Where appropriate, property types, method arguments, and the arguments -provided to event handlers are detailed in a list underneath the topic -heading. +Node.js is a JavaScript runtime built on the [V8 JavaScript engine][]. ## Contributing @@ -90,3 +86,4 @@ issue 4760](https://github.com/nodejs/node/issues/4760). [`stderr`]: process.html#process_process_stderr [submit an issue]: https://github.com/nodejs/node/issues/new [the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md +[V8 JavaScript engine]: https://v8.dev/