doc: add documentation regarding our api tooling - #45270
Conversation
Sorry, something went wrong.
|
Review requested:
|
Sorry, something went wrong.
|
I think we should change the name of the doc/contributing/node-apidocs-tooling.md. Otherwise it may be confused as something related to node-api specifically |
Sorry, something went wrong.
|
@ovflowd thanks for pulling this together it is super useful. As always with docs lots of suggestions/nickpicks but I think this is a really good addition to our docs and it already has more that enough content to land (after incorporating suggestions) and then iterate on as we go forward. It think it will be a really good reference for discussions on this is how doc generation works now -> this is how we want to change it. |
Sorry, something went wrong.
|
Thanks, @mhdawson and @VoltrexMaster, for the reviews! Nitpicking here is completely fine, and better releasing a well-written doc rather than an incomplete and hard-to-understand one. I was busy during this week, but I will take my good time this weekend by working on them! |
Sorry, something went wrong.
Introduces a proper imperative description of how the current API documentation build system works. Refs: nodejs/next-10#169
|
I finished applying all the changes and fixed lining issues 🎉 |
Sorry, something went wrong.
mhdawson
left a comment
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
|
@mhdawson do we need anything else here? 👀 or are we good to 🚢 |
Sorry, something went wrong.
|
I was hoping for 1 more approval, but since we are past 7 days this can land with 1. Doing that now. |
Sorry, something went wrong.
Introduces a proper imperative description of how the current API documentation build system works. Refs: nodejs/next-10#169 PR-URL: #45270 Reviewed-By: Michael Dawson <midawson@redhat.com>
|
@ovflowd again many thanks for taking the time to put this together. |
Sorry, something went wrong.
Introduces a proper imperative description of how the current API documentation build system works. Refs: nodejs/next-10#169 PR-URL: #45270 Reviewed-By: Michael Dawson <midawson@redhat.com>
Introduces a proper imperative description of how the current API documentation build system works. Refs: nodejs/next-10#169 PR-URL: #45270 Reviewed-By: Michael Dawson <midawson@redhat.com>
Introduces a proper imperative description of how the current API documentation build system works. Refs: nodejs/next-10#169 PR-URL: #45270 Reviewed-By: Michael Dawson <midawson@redhat.com>
Introduces a proper imperative description of how the current API documentation build system works.
Refs: nodejs/next-10#169
cc @mhdawson @nodejs/next-10 @benhalverson @nodejs/tooling