Skip to content

Commit

Permalink
doc: mention quicker way to build docs
Browse files Browse the repository at this point in the history
`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>
  • Loading branch information
crawford authored and marco-ippolito committed Jun 17, 2024
1 parent 972eafd commit 3a1d17a
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions doc/contributing/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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

0 comments on commit 3a1d17a

Please sign in to comment.