Commit Graph

5 Commits (854d23b0d60bec3ebdaf5b4c05a4f57fd1bbf62a)

Author SHA1 Message Date
Alex Crawford d272625d54
doc: mention quicker way to build docs
`make doc-only` skips the process of building Node, which speeds
things up considerably for new contributors.

PR-URL: https://github.com/nodejs/node/pull/52937
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com>
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2024-05-12 18:54:03 +00:00
Augustin Mauroy a63261cf2c
doc: add missing space
PR-URL: https://github.com/nodejs/node/pull/52360
Reviewed-By: Ulises Gascón <ulisesgascongonzalez@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2024-04-04 10:57:36 +00:00
Mohammed Keyvanzadeh 32e478d7c3
doc: fix typos
PR-URL: https://github.com/nodejs/node/pull/47685
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Debadree Chatterjee <debadree333@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
2023-04-23 13:34:08 +00:00
Michael Dawson e42425b2d6 doc: add detail on how api docs are published
Add some details that Richard shared with me on
how the docs are published to the website.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/45626
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2022-12-02 14:26:33 -05:00
Claudio Wunder bf28da8617 tools: add documentation regarding our api tooling
Introduces a proper imperative description of how the
current API documentation build system works.

Refs: https://github.com/nodejs/next-10/issues/169

PR-URL: https://github.com/nodejs/node/pull/45270
Reviewed-By: Michael Dawson <midawson@redhat.com>
2022-11-09 13:18:46 -05:00