Skip to content
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

Closed

Conversation

ovflowd
Copy link
Member

@ovflowd ovflowd commented Nov 1, 2022

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

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 1, 2022
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
doc/contributing/node-api-tooling.md Outdated Show resolved Hide resolved
@mhdawson
Copy link
Member

mhdawson commented Nov 4, 2022

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

@mhdawson
Copy link
Member

mhdawson commented Nov 4, 2022

@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.

@ovflowd
Copy link
Member Author

ovflowd commented Nov 4, 2022

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!

@ovflowd ovflowd force-pushed the feat/contribution-guidelines-node-api branch 2 times, most recently from 9512f14 to accb63c Compare November 6, 2022 09:48
Introduces a proper imperative description of how the
current API documentation build system works.

Refs: nodejs/next-10#169
@ovflowd ovflowd force-pushed the feat/contribution-guidelines-node-api branch from accb63c to 1a15a2c Compare November 6, 2022 10:10
@ovflowd
Copy link
Member Author

ovflowd commented Nov 6, 2022

I finished applying all the changes and fixed lining issues 🎉

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mhdawson mhdawson added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Nov 8, 2022
@ovflowd ovflowd changed the title tools: add documentation regarding our api tooling doc: add documentation regarding our api tooling Nov 9, 2022
@ovflowd
Copy link
Member Author

ovflowd commented Nov 9, 2022

@mhdawson do we need anything else here? 👀 or are we good to 🚢

@mhdawson
Copy link
Member

mhdawson commented Nov 9, 2022

I was hoping for 1 more approval, but since we are past 7 days this can land with 1. Doing that now.

@mhdawson
Copy link
Member

mhdawson commented Nov 9, 2022

Landed in bf28da8

@mhdawson mhdawson closed this Nov 9, 2022
mhdawson pushed a commit that referenced this pull request Nov 9, 2022
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>
@mhdawson
Copy link
Member

mhdawson commented Nov 9, 2022

@ovflowd again many thanks for taking the time to put this together.

@ovflowd ovflowd deleted the feat/contribution-guidelines-node-api branch November 9, 2022 18:21
RafaelGSS pushed a commit that referenced this pull request Nov 10, 2022
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>
@RafaelGSS RafaelGSS mentioned this pull request Nov 10, 2022
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
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>
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
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>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
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>
danielleadams pushed a commit that referenced this pull request Jan 4, 2023
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants