Skip to content

Commit c375cf0

Browse files
committed
doc: mention quicker way to build docs
`make doc-only` skips the process of building Node, which speeds things up considerably for new contributors.
1 parent 951af83 commit c375cf0

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/contributing/api-documentation.md

Lines changed: 4 additions & 3 deletions
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)