GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: add documentation regarding our api tooling by ovflowd · Pull Request #45270 · nodejs/node

Conversation

@ovflowd

@ovflowd ovflowd commented Nov 1, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

bricss reacted with eyes emoji
All reactions
  • 👀 1 reaction
@nodejs-github-bot

nodejs-github-bot commented Nov 1, 2022

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/tsc
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to Node.js documentation. label Nov 1, 2022
Trott
Trott reviewed Nov 1, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

VoltrexKeyva
VoltrexKeyva reviewed Nov 2, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson

mhdawson commented Nov 4, 2022

Copy link
Copy Markdown
Member

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

ovflowd reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 4, 2022
View reviewed changes
Comment thread doc/contributing/node-api-tooling.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson

mhdawson commented Nov 4, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

@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 reacted with heart emoji
All reactions
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ovflowd

ovflowd commented Nov 4, 2022

Copy link
Copy Markdown
Member Author

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!

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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
Claudio Wunder
tools: add documentation regarding our api tooling
1a15a2c
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

ovflowd commented Nov 6, 2022

Copy link
Copy Markdown
Member Author

I finished applying all the changes and fixed lining issues 🎉

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

mhdawson
mhdawson reviewed Nov 8, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson
Update doc/contributing/api-documentation.md
cb27d04
mhdawson
mhdawson reviewed Nov 8, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson
Update doc/contributing/api-documentation.md
dd88818
mhdawson
mhdawson reviewed Nov 8, 2022
View reviewed changes
Comment thread doc/contributing/api-documentation.md Resolved

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson
Update doc/contributing/api-documentation.md
7913513
mhdawson
mhdawson approved these changes Nov 8, 2022
View reviewed changes

@mhdawson mhdawson left a comment

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

ovflowd reacted with hooray emoji
All reactions
  • 🎉 1 reaction
@mhdawson mhdawson added the author ready PRs with CI started, the required approvals, and no outstanding review comments. 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

ovflowd commented Nov 9, 2022

Copy link
Copy Markdown
Member Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson

mhdawson commented Nov 9, 2022

Copy link
Copy Markdown
Member

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

ovflowd reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson

mhdawson commented Nov 9, 2022

Copy link
Copy Markdown
Member

Landed in bf28da8

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@mhdawson mhdawson closed this Nov 9, 2022
mhdawson pushed a commit that referenced this pull request Nov 9, 2022
Claudio Wunder @mhdawson
tools: add documentation regarding our api tooling
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 <[email protected]>
@mhdawson

mhdawson commented Nov 9, 2022

Copy link
Copy Markdown
Member

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

ovflowd reacted with heart emoji
All reactions
  • ❤️ 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@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
Claudio Wunder @RafaelGSS
tools: add documentation regarding our api tooling
9aa305f
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 <[email protected]>
@RafaelGSS RafaelGSS mentioned this pull request Nov 10, 2022
v19.1.0 proposal #45269
Merged
@danielleadams danielleadams mentioned this pull request Dec 30, 2022
v18.13.0 release proposal #46025
Merged
danielleadams pushed a commit that referenced this pull request Dec 30, 2022
Claudio Wunder @danielleadams
tools: add documentation regarding our api tooling
ee71f77
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 <[email protected]>
danielleadams pushed a commit that referenced this pull request Jan 3, 2023
Claudio Wunder @danielleadams
tools: add documentation regarding our api tooling
04f213b
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 <[email protected]>
@MikeMcC399 MikeMcC399 mentioned this pull request Jan 3, 2026
doc: correct typo in api contributing doc #61260
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Trott Trott Trott left review comments
+2 more reviewers
@mhdawson mhdawson mhdawson approved these changes
@VoltrexKeyva VoltrexKeyva VoltrexKeyva left review comments
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

author ready PRs with CI started, the required approvals, and no outstanding review comments. doc Issues and PRs related to Node.js documentation.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@ovflowd @nodejs-github-bot @mhdawson @Trott @VoltrexKeyva
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.