lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
12752 Commits
131 Branches
446 Tags
325 MiB
Tree: 36e8a2c63d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '36e8a2c63d'
${ noResults }
node/doc/api/documentation.markdown

69 lines
2.3 KiB
Raw Normal View History

Add 'about these docs' section
13 years ago
# About this Documentation
<!-- type=misc -->
node: rename from io.js to node This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt; Reviewed-By: João Reis &lt;reis@janeasystems.com&gt;
10 years ago
The goal of this documentation is to comprehensively explain the Node.js
Add &#39;about these docs&#39; section
13 years ago
API, both from a reference as well as a conceptual point of view. Each
section describes a built-in module or high-level concept.
Where appropriate, property types, method arguments, and the arguments
provided to event handlers are detailed in a list underneath the topic
heading.
Every `.html` document has a corresponding `.json` document presenting
the same information in a structured manner. This feature is
experimental, and added for the benefit of IDEs and other utilities that
wish to do programmatic things with the documentation.
Every `.html` and `.json` file is generated based on the corresponding
node: rename from io.js to node This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt; Reviewed-By: João Reis &lt;reis@janeasystems.com&gt;
10 years ago
`.markdown` file in the `doc/api/` folder in Node.js's source tree. The
Add &#39;about these docs&#39; section
13 years ago
documentation is generated using the `tools/doc/generate.js` program.
The HTML template is located at `doc/template.html`.
## Stability Index
<!--type=misc-->
Throughout the documentation, you will see indications of a section's
node: rename from io.js to node This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell &lt;jasnell@gmail.com&gt; Reviewed-By: João Reis &lt;reis@janeasystems.com&gt;
10 years ago
stability. The Node.js API is still somewhat changing, and as it
Add &#39;about these docs&#39; section
13 years ago
matures, certain parts are more reliable than others. Some 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
and in the process of being redesigned.
The stability indices are as follows:
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
Stability: 0 - Deprecated
This feature is known to be problematic, and changes are
Add &#39;about these docs&#39; section
13 years ago
planned. Do not rely on it. Use of the feature may cause warnings. Backwards
compatibility should not be expected.
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
Add &#39;about these docs&#39; section
13 years ago
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
Stability: 1 - Experimental
doc: update stability index This simplifies the stability index to 4 levels: 0 - deprecated 1 - experimental / feature-flagged 2 - stable 3 - locked Domains has been downgraded to deprecated, assert has been downgraded to stable. Timers and Module remain locked. All other APIs are now stable. PR-URL: https://github.com/iojs/io.js/pull/943 Fixes: https://github.com/iojs/io.js/issues/930 Reviewed-By: Colin Ihrig &lt;cjihrig@gmail.com&gt; Reviewed-By: Jeremiah Senkpiel &lt;fishrock123@rocketmail.com&gt; Reviewed-By: Vladimir Kurchatkin &lt;vladimir.kurchatkin@gmail.com&gt;
10 years ago
This feature is subject to change, and is gated by a command line flag.
It may change or be removed in future versions.
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
Add &#39;about these docs&#39; section
13 years ago
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
doc: update stability index This simplifies the stability index to 4 levels: 0 - deprecated 1 - experimental / feature-flagged 2 - stable 3 - locked Domains has been downgraded to deprecated, assert has been downgraded to stable. Timers and Module remain locked. All other APIs are now stable. PR-URL: https://github.com/iojs/io.js/pull/943 Fixes: https://github.com/iojs/io.js/issues/930 Reviewed-By: Colin Ihrig &lt;cjihrig@gmail.com&gt; Reviewed-By: Jeremiah Senkpiel &lt;fishrock123@rocketmail.com&gt; Reviewed-By: Vladimir Kurchatkin &lt;vladimir.kurchatkin@gmail.com&gt;
10 years ago
Stability: 2 - Stable
The API has proven satisfactory. Compatibility with the npm ecosystem
is a high priority, and will not be broken unless absolutely necessary.
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
Add &#39;about these docs&#39; section
13 years ago
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
doc: update stability index This simplifies the stability index to 4 levels: 0 - deprecated 1 - experimental / feature-flagged 2 - stable 3 - locked Domains has been downgraded to deprecated, assert has been downgraded to stable. Timers and Module remain locked. All other APIs are now stable. PR-URL: https://github.com/iojs/io.js/pull/943 Fixes: https://github.com/iojs/io.js/issues/930 Reviewed-By: Colin Ihrig &lt;cjihrig@gmail.com&gt; Reviewed-By: Jeremiah Senkpiel &lt;fishrock123@rocketmail.com&gt; Reviewed-By: Vladimir Kurchatkin &lt;vladimir.kurchatkin@gmail.com&gt;
10 years ago
Stability: 3 - Locked
Only fixes related to security, performance, or bug fixes will be accepted.
Please do not suggest API changes in this area; they will be refused.
Colorize API stabilitity index headers in docs Noted in @shtylman&#39;s #3898, API stability notes are easy to overlook in the html documentation. This can be especially troublesome if the API is deprecated. This commit gives visual feedback by adding in a class to the html docs when they&#39;re generated. The API headers with corresponding colors are also listed in the &#39;About this Documentation&#39; page for easy reference.
12 years ago
```
doc: Document JSON docs
13 years ago
## JSON Output
Stability: 1 - Experimental
Every HTML file in the markdown has a corresponding JSON file with the
same data.
doc: standardize references to node.js in docs trivial commit to fix a couple inconsistent references to the name of the project PR-URL: https://github.com/nodejs/node/pull/4136 Reviewed-By: Colin Ihrig &lt;cjihrig@gmail.com&gt; Reviewed-By: Roman Klauke &lt;romaaan.git@gmail.com&gt; Reviewed-By: Roman Reiss &lt;me@silverwind.io&gt;
9 years ago
This feature was added in Node.js v0.6.12. It is experimental.