From 3a1d17a9b1bd0c60666b7e4b7364fe5cbd086c8e Mon Sep 17 00:00:00 2001 From: Alex Crawford Date: Sun, 12 May 2024 11:54:03 -0700 Subject: [PATCH] doc: mention quicker way to build docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `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 Reviewed-By: Rafael Gonzaga Reviewed-By: Richard Lau Reviewed-By: Marco Ippolito Reviewed-By: Ulises Gascón Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- doc/contributing/api-documentation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/contributing/api-documentation.md b/doc/contributing/api-documentation.md index af58c6e53a482c..ffe1cef1386765 100644 --- 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