1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: rewrite "About this Documentation" section

Browse Source 
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 <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
This commit is contained in:
Rich Trott 2019-05-15 20:24:21 -07:00 committed by Anna Henningsen
parent 4a7b8eae84
commit bd895af1f8
No known key found for this signature in database
GPG Key ID: 9C63F3A6CD2AD8F9
1 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/documentation.md
View File

@ -3,13 +3,9 @@
<!--introduced_in=v0.10.0-->
<!-- type=misc -->
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/