Skip to content

Commit

Permalink
doc: rewrite "About this Documentation" section
Browse files Browse the repository at this point in the history
Replace the "About this Documentation" section with a simple welcome
message and a concise description of Node.js

PR-URL: #27725
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
  • Loading branch information
Trott authored and targos committed May 20, 2019
1 parent df01645 commit cf516f7
Showing 1 changed file with 3 additions and 6 deletions.
9 changes: 3 additions & 6 deletions doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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/

0 comments on commit cf516f7

Please sign in to comment.