Skip to content

Commit cf516f7

Browse files
Trotttargos
authored andcommitted
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: #27725 Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent df01645 commit cf516f7

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

doc/api/documentation.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,9 @@
33
<!--introduced_in=v0.10.0-->
44
<!-- type=misc -->
55

6-
The goal of this documentation is to explain the Node.js
7-
API, both from a reference as well as a conceptual point of view. Each
8-
section describes a built-in module or high-level concept.
6+
Welcome to the official API reference documentation for Node.js!
97

10-
Where appropriate, property types, method arguments, and the arguments
11-
provided to event handlers are detailed in a list underneath the topic
12-
heading.
8+
Node.js is a JavaScript runtime built on the [V8 JavaScript engine][].
139

1410
## Contributing
1511

@@ -90,3 +86,4 @@ issue 4760](https://github.com/nodejs/node/issues/4760).
9086
[`stderr`]: process.html#process_process_stderr
9187
[submit an issue]: https://github.com/nodejs/node/issues/new
9288
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
89+
[V8 JavaScript engine]: https://v8.dev/

0 commit comments

Comments
 (0)