-
Notifications
You must be signed in to change notification settings - Fork 30k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc: add documentation regarding our api tooling #45270
doc: add documentation regarding our api tooling #45270
Conversation
Review requested:
|
I think we should change the name of the |
@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. |
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! |
9512f14
to
accb63c
Compare
Introduces a proper imperative description of how the current API documentation build system works. Refs: nodejs/next-10#169
accb63c
to
1a15a2c
Compare
I finished applying all the changes and fixed lining issues 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
@mhdawson do we need anything else here? 👀 or are we good to 🚢 |
I was hoping for 1 more approval, but since we are past 7 days this can land with 1. Doing that now. |
Landed in bf28da8 |
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. |
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 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