@@ -48,24 +48,24 @@ meant to be a guide on how to write documentation for Node.js.
4848
4949## Vocabulary & Good to Know's
5050
51- - AST means "Abstract Syntax Tree" and it is a data structure that represents
51+ * AST means "Abstract Syntax Tree" and it is a data structure that represents
5252 the structure of a certain data format. In our case, the AST is a "graph"
5353 representation of the contents of the Markdown file.
54- - MDN means [ Mozilla Developer Network] ( https://developer.mozilla.org/en-US/ )
54+ * MDN means [ Mozilla Developer Network] ( https://developer.mozilla.org/en-US/ )
5555 and it is a website that contains documentation for web technologies. We use
5656 it as a reference for the structure of the documentation.
57- - The
57+ * The
5858 [ Stability Index] ( https://nodejs.org/dist/latest/docs/api/documentation.html#stability-index )
5959 is used to community the Stability of a given Node.js module. The Stability
6060 levels include:
61- - Stability 0: Deprecated. (This module is Deprecated)
62- - Stability 1: Experimental. (This module is Experimental)
63- - Stability 2: Stable. (This module is Stable)
64- - Stability 3: Legacy. (This module is Legacy)
65- - Within Remark YAML snippets ` <!-- something --> ` are considered HTML nodes,
61+ * Stability 0: Deprecated. (This module is Deprecated)
62+ * Stability 1: Experimental. (This module is Experimental)
63+ * Stability 2: Stable. (This module is Stable)
64+ * Stability 3: Legacy. (This module is Legacy)
65+ * Within Remark YAML snippets ` <!-- something --> ` are considered HTML nodes,
6666 that's because YAML isn't valid Markdown content. (Doesn't abide by the
6767 Markdown spec)
68- - "New Tooling" references to the (written from-scratch) API build tooling
68+ * "New Tooling" references to the (written from-scratch) API build tooling
6969 introduced in ` nodejs/nodejs.dev ` that might replace the current one from
7070 ` nodejs/node `
7171
0 commit comments