doc: mention quicker way to build docs

crawford · marco-ippolito · commit 3a1d17a9b1bd · 2024-06-17T16:25:22.000+02:00
`make doc-only` skips the process of building Node, which speeds things up considerably for new contributors. PR-URL: #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>
diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md
@@ -4,9 +4,8 @@ The Node.js API documentation is generated by an in-house tooling that resides
 within the [tools/doc](https://github.com/nodejs/node/tree/main/tools/doc)
 directory.
 
-The build process (using `make doc`) uses this tooling to parse the markdown
-files in [doc/api](https://github.com/nodejs/node/tree/main/doc/api) and
-generate the following:
+The build process (using `make doc` or `make doc-only`) uses this tooling to
+parse the markdown files in [`doc/api/`][] and generate the following:
 
 1. Human-readable HTML in `out/doc/api/*.html`
 2. A JSON representation in `out/doc/api/*.json`
@@ -302,3 +301,5 @@ mutate the data and appends it to the final JSON object.
 
 For a more in-depth information we recommend to refer to the `json.mjs` file as
 it contains a lot of comments.
+
+[`doc/api/`]: https://github.com/nodejs/node/tree/main/doc/api
