delta/node-new.git/doc/api/documentation.md, branch main

doc: add experimental stages

2023-01-14T14:25:08+00:00

PR-URL: https://github.com/nodejs/node/pull/46100
Reviewed-By: Darshan Sen 
Reviewed-By: Michaël Zasso 
Reviewed-By: Michael Dawson 
Reviewed-By: Chengzhong Wu 
Reviewed-By: Сковорода Никита Андреевич

doc: add `stability` class to legacy status description

2022-03-30T15:49:29+00:00

PR-URL: https://github.com/nodejs/node/pull/42525
Reviewed-By: Antoine du Hamel 
Reviewed-By: Tobias Nießen 
Reviewed-By: Darshan Sen

doc: standardize typography for _semantic versioning_

2022-03-21T17:57:10+00:00

PR-URL: https://github.com/nodejs/node/pull/42401
Reviewed-By: Tobias Nießen 
Reviewed-By: Luigi Pinca 
Reviewed-By: Mestery 
Reviewed-By: Akhil Marsonya 
Reviewed-By: Darshan Sen

doc: clarify the meaning of legacy status

2022-03-14T05:10:08+00:00

Fixes: https://github.com/nodejs/node/issues/42230
Fixes: https://github.com/nodejs/node/issues/42232

Signed-off-by: Darshan Sen 

PR-URL: https://github.com/nodejs/node/pull/42269
Reviewed-By: Rich Trott 
Reviewed-By: James M Snell 
Reviewed-By: Michaël Zasso 
Reviewed-By: Mestery 
Reviewed-By: Luigi Pinca 
Reviewed-By: Mohammed Keyvanzadeh 
Reviewed-By: Tobias Nießen 
Reviewed-By: Gireesh Punathil 
Reviewed-By: Matteo Collina

doc: format doc/api/*.md with markdown formatter

2021-10-20T09:59:11+00:00

PR-URL: https://github.com/nodejs/node/pull/40403
Reviewed-By: Benjamin Gruenbaum 
Reviewed-By: Zijian Liu 
Reviewed-By: Michaël Zasso 
Reviewed-By: Antoine du Hamel

doc: add blank line between comments

2021-09-22T01:40:04+00:00

Upcoming remark-based formatting/linting will add a blank line between
comments in markdown. This is in preparation for that change.

PR-URL: https://github.com/nodejs/node/pull/40160
Reviewed-By: Michaël Zasso 
Reviewed-By: Antoine du Hamel 
Reviewed-By: James M Snell 
Reviewed-By: Luigi Pinca

doc: anchor link parity between markdown and html-generated docs

2021-08-29T22:40:20+00:00

Main changes:

- Replace current HTML anchor generation to match
  header anchor generation in Github markdown.
- Remove unnecessary double namespacing on generated anchors/links (E.G.
  `esm.md#loaders` instead of `esm.md#esm_loaders`).
- Anchors/links are automatically prefixed with their respective modules
  when concatenated for usage in `all.html`.

Benefits:

- All anchor links within and between markdown API docs actually work.
- Adding new anchor links no longer requires contributors to generate
  the HTML docs first to look up the correct anchors.
- Anchors are much shorter.
- All previous anchor links are preserved by generating hidden legacy
  anchors.

PR-URL: https://github.com/nodejs/node/pull/39304
Reviewed-By: Antoine du Hamel

doc,tools: allow stability table to be updated

2021-04-06T04:14:44+00:00

Keep markers for the stability table so that it can be updated on
subsequent runs of the doc tooling. Only overwrite the files if
they have been changed.

PR-URL: https://github.com/nodejs/node/pull/38048
Fixes: https://github.com/nodejs/node/issues/37886
Reviewed-By: Antoine du Hamel 
Reviewed-By: Rich Trott 
Reviewed-By: Colin Ihrig 
Reviewed-By: Juan José Arboleda

doc: fix legacy stability indicator display

2021-03-22T14:00:47+00:00

PR-URL: https://github.com/nodejs/node/pull/37838
Reviewed-By: Darshan Sen 
Reviewed-By: Michaël Zasso 
Reviewed-By: Colin Ihrig 
Reviewed-By: Benjamin Gruenbaum 
Reviewed-By: Zijian Liu

doc: add legacy status to stability index

2021-03-19T19:38:41+00:00

Signed-off-by: James M Snell 

PR-URL: https://github.com/nodejs/node/pull/37784
Reviewed-By: Anna Henningsen 
Reviewed-By: Matteo Collina 
Reviewed-By: Vladimir de Turckheim 
Reviewed-By: Michaël Zasso 
Reviewed-By: Michael Dawson 
Reviewed-By: Beth Griggs