mirrors/nodejs
mirrors/nodejs
0
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2024-11-29 15:06:33 +01:00
Code Issues Releases Activity
53fb2b6b41
nodejs/doc/api/documentation.md

67 lines
2.2 KiB
Markdown
Raw Normal View History

doc: use sentence-case for headings in docs PR-URL: https://github.com/nodejs/node/pull/33889 Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings Refs: https://docs.microsoft.com/en-us/style-guide/capitalization Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-06-14 23:49:34 +02:00
# About this documentation
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
doc: add links to alternative versions of doc Each page of the API documentation should have links to other versions of the same page. This will make it easier to switch between the current "live" release at nodejs.org and LTS versions. PR-URL: https://github.com/nodejs/node/pull/10958 Fixes: https://github.com/nodejs/node/issues/10726 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2017-01-23 04:16:21 +01:00
<!--introduced_in=v0.10.0-->
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
<!-- type=misc -->
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 <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2019-05-16 05:24:21 +02:00
Welcome to the official API reference documentation for Node.js!
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
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 <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2019-05-16 05:24:21 +02:00
Node.js is a JavaScript runtime built on the [V8 JavaScript engine][].
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
doc: improve documentation.md Reworded some parts, inter-doc links. PR-URL: https://github.com/nodejs/node/pull/17702 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2017-12-15 22:49:36 +01:00
## Contributing
doc: add info to docs on how to submit docs patch The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: https://github.com/nodejs/node/pull/4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-08 19:32:50 +01:00
doc: simplify contributing documentation Remove out-of-place detail about filesystem layout and tools for generating documentation. Link to the issue tracker and the contribution guide with clear, concise sentences. PR-URL: https://github.com/nodejs/node/pull/27785 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-21 01:18:46 +02:00
Report errors in this documentation in [the issue tracker][]. See
[the contributing guide][] for directions on how to submit pull requests.
doc: add info to docs on how to submit docs patch The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: https://github.com/nodejs/node/pull/4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-08 19:32:50 +01:00
doc: use sentence-case for headings in docs PR-URL: https://github.com/nodejs/node/pull/33889 Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings Refs: https://docs.microsoft.com/en-us/style-guide/capitalization Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-06-14 23:49:34 +02:00
## Stability index
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
<!--type=misc-->
doc: edit stability index overview Edit the stability index overview to be more concise. Remove some awkward and unclear phrasing. PR-URL: https://github.com/nodejs/node/pull/27831 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-23 01:29:11 +02:00
Throughout the documentation are indications of a section's stability. Some APIs
are so proven and so relied upon that they are unlikely to ever change at all.
Others are brand new and experimental, or known to be hazardous.
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
The stability indices are as follows:
doc: make Stability Index more concise Shorten the Stability Index text. PR-URL: https://github.com/nodejs/node/pull/22544 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2018-08-27 03:30:48 +02:00
> Stability: 0 - Deprecated. The feature may emit warnings. Backward
> compatibility is not guaranteed.
doc, tools: unify stability signatures PR-URL: https://github.com/nodejs/node/pull/20552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-05-06 02:59:23 +02:00
<!-- separator -->
doc: add link to sem-ver info PR-URL: https://github.com/nodejs/node/pull/31985 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2020-02-27 18:30:24 +01:00
> Stability: 1 - Experimental. The feature is not subject to
> [Semantic Versioning][] rules. Non-backward compatible changes or removal may
> occur in any future release. Use of the feature is not recommended in
> production environments.
doc, tools: unify stability signatures PR-URL: https://github.com/nodejs/node/pull/20552 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2018-05-06 02:59:23 +02:00
<!-- separator -->
doc: make Stability Index more concise Shorten the Stability Index text. PR-URL: https://github.com/nodejs/node/pull/22544 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Minwoo Jung <minwoo@nodesource.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2018-08-27 03:30:48 +02:00
> Stability: 2 - Stable. Compatibility with the npm ecosystem is a high
> priority.
Add 'about these docs' section
2012-02-27 20:06:14 +01:00
doc: revise additional Experimental status text Clarify and simplify material urging caution with Experimental features. PR-URL: https://github.com/nodejs/node/pull/27931 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-28 07:59:03 +02:00
Use caution when making use of Experimental features, particularly within
modules. End users may not be aware that experimental features are being used.
Bugs or behavior changes may surprise end users when Experimental API
modifications occur. To avoid surprises, use of an Experimental feature may need
a command-line flag. Experimental features may also emit a [warning][].
doc: improve documentation.md Reworded some parts, inter-doc links. PR-URL: https://github.com/nodejs/node/pull/17702 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2017-12-15 22:49:36 +01:00
doc: use sentence-case for headings in docs PR-URL: https://github.com/nodejs/node/pull/33889 Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings Refs: https://docs.microsoft.com/en-us/style-guide/capitalization Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-06-14 23:49:34 +02:00
## JSON output
doc: improve documentation.md Reworded some parts, inter-doc links. PR-URL: https://github.com/nodejs/node/pull/17702 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
2017-12-15 22:49:36 +01:00
<!-- YAML
added: v0.6.12
-->
doc: Document JSON docs
2012-03-04 00:51:14 +01:00
doc: remove experimental status for JSON documentation The JSON documentation is relied up on by some consumers. It has been in Experimental status for a long time. Promote it to Stable. Reword the JSON documentation overview for brevity and clarity. PR-URL: https://github.com/nodejs/node/pull/27842 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-23 20:45:49 +02:00
Every `.html` document has a corresponding `.json` document. This is for IDEs
and other utilities that consume the documentation.
doc: link to man pages This changes the doc generator to automatically link references such as `open(2)` to a man page on man7.org or freebsd.org PR-URL: https://github.com/nodejs/node/pull/5073 Reviewed-By: Ben Noorhduis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-02-04 13:11:17 +01:00
doc: simplify system call material in doc overview PR-URL: https://github.com/nodejs/node/pull/27966 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-05-30 10:00:11 +02:00
## System calls and man pages
doc: link to man pages This changes the doc generator to automatically link references such as `open(2)` to a man page on man7.org or freebsd.org PR-URL: https://github.com/nodejs/node/pull/5073 Reviewed-By: Ben Noorhduis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-02-04 13:11:17 +01:00
doc: simplify system call material in doc overview PR-URL: https://github.com/nodejs/node/pull/27966 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-05-30 10:00:11 +02:00
Node.js functions which wrap a system call will document that. The docs link
to the corresponding man pages which describe how the system call works.
doc: link to man pages This changes the doc generator to automatically link references such as `open(2)` to a man page on man7.org or freebsd.org PR-URL: https://github.com/nodejs/node/pull/5073 Reviewed-By: Ben Noorhduis <info@bnoordhuis.nl> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
2016-02-04 13:11:17 +01:00
doc: simplify system call material in doc overview PR-URL: https://github.com/nodejs/node/pull/27966 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2019-05-30 10:00:11 +02:00
Most Unix system calls have Windows analogues. Still, behavior differences may
be unavoidable.
doc: add info to docs on how to submit docs patch The docs mentioned that the docs source live in the node source, but did not link to same. PR-URL: https://github.com/nodejs/node/pull/4591 Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-01-08 19:32:50 +01:00
doc: add link to sem-ver info PR-URL: https://github.com/nodejs/node/pull/31985 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2020-02-27 18:30:24 +01:00
[Semantic Versioning]: https://semver.org/
doc: add quotes for event names + fix similar nits PR-URL: https://github.com/nodejs/node/pull/19915 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2018-04-09 18:30:22 +02:00
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
doc: simplify contributing documentation Remove out-of-place detail about filesystem layout and tools for generating documentation. Link to the issue tracker and the contribution guide with clear, concise sentences. PR-URL: https://github.com/nodejs/node/pull/27785 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-21 01:18:46 +02:00
[the issue tracker]: https://github.com/nodejs/node/issues/new
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 <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2019-05-16 05:24:21 +02:00
[V8 JavaScript engine]: https://v8.dev/
doc: revise additional Experimental status text Clarify and simplify material urging caution with Experimental features. PR-URL: https://github.com/nodejs/node/pull/27931 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-05-28 07:59:03 +02:00
[warning]: process.html#process_event_warning
Copy Permalink