Skip to content

Commit 3a1d17a

Browse files
crawfordmarco-ippolito
authored andcommittedJun 17, 2024
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: #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>
1 parent 972eafd commit 3a1d17a

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed
 

‎doc/contributing/api-documentation.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ The Node.js API documentation is generated by an in-house tooling that resides
44
within the [tools/doc](https://github.com/nodejs/node/tree/main/tools/doc)
55
directory.
66

7-
The build process (using `make doc`) uses this tooling to parse the markdown
8-
files in [doc/api](https://github.com/nodejs/node/tree/main/doc/api) and
9-
generate the following:
7+
The build process (using `make doc` or `make doc-only`) uses this tooling to
8+
parse the markdown files in [`doc/api/`][] and generate the following:
109

1110
1. Human-readable HTML in `out/doc/api/*.html`
1211
2. A JSON representation in `out/doc/api/*.json`
@@ -302,3 +301,5 @@ mutate the data and appends it to the final JSON object.
302301

303302
For a more in-depth information we recommend to refer to the `json.mjs` file as
304303
it contains a lot of comments.
304+
305+
[`doc/api/`]: https://github.com/nodejs/node/tree/main/doc/api

0 commit comments

Comments
 (0)
Please sign in to comment.