Skip to content

build, doc: use new api doc tooling - #57343

Merged
nodejs-github-bot merged 11 commits into
nodejs:mainfrom
flakey5:flakey5/20250305/api-docs-tooling
Feb 27, 2026
Merged

build, doc: use new api doc tooling#57343
nodejs-github-bot merged 11 commits into
nodejs:mainfrom
flakey5:flakey5/20250305/api-docs-tooling

Conversation

@flakey5

@flakey5flakey5 commented Mar 6, 2025

Copy link
Copy Markdown
Member

Switches over to using the new doc generation tooling. For more background on this, please see #52343

Currently a draft just to get feedback on the approach to this integration.

cc @nodejs/web-infra


Notable Change info (by @avivkeller):

The Node.js Website and Website Infrastructure teams have introduced a brand-new documentation pipeline, modernizing how our API docs are generated. While the documentation site may look familiar today, we are hard at work making a completely refreshed user interface in the very near future!

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/nodejs-website
  • @nodejs/web-infra

@nodejs-github-botnodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. windows Issues and PRs related to the Windows platform. labels Mar 6, 2025
@flakey5
flakey5 marked this pull request as draft March 6, 2025 06:24
@flakey5
flakey5force-pushed the flakey5/20250305/api-docs-tooling branch from 77ede22 to 3423c21CompareMarch 6, 2025 06:29
Comment threadMakefile Outdated
Comment threadvcbuild.bat Outdated
@flakey5
flakey5force-pushed the flakey5/20250305/api-docs-tooling branch from 3423c21 to 451f8a7CompareMarch 6, 2025 06:31
Comment threadtools/doc/README.md
ovflowd

This comment was marked as outdated.

@flakey5
flakey5force-pushed the flakey5/20250305/api-docs-tooling branch 3 times, most recently from cf2609b to a3ce99dCompareMarch 10, 2025 22:04
@flakey5
flakey5 marked this pull request as ready for review March 10, 2025 22:05
@flakey5

This comment was marked as resolved.

@flakey5

This comment was marked as resolved.

@ovflowd

This comment was marked as resolved.

@codecov

codecovBot commented Mar 10, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.73%. Comparing base (9cc7fcc) to head (b313181).
⚠️ Report is 69 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #57343 +/- ##
==========================================
+ Coverage 89.72% 89.73% +0.01% 
==========================================
Files 675 676 +1 Lines 204797 206069 +1272 Branches 39344 39519 +175 ==========================================
+ Hits 183752 184919 +1167 + Misses 13324 13302 -22 - Partials 7721 7848 +127 

see 166 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment threadMakefile Outdated
@araujogui

This comment was marked as resolved.

@araujogui

This comment was marked as resolved.

@ovflowd

This comment was marked as resolved.

Comment threadMakefile Outdated

@ovflowdovflowd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is the result of many months of arduous work between many awesome folks, including @flakey5@AugustinMauroy@araujogui@ovflowd@avivkeller and others.

I'm so proud of what we are achieving here and this is a huge step towards a modern tooling and a revamped API docs within Node.js

Approving, as I believe this is ready!

@ovflowd

This comment was marked as resolved.

@lpincalpinca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

RSLGTM because it is hard to review and outside of my comfort zone.

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@ovflowdovflowd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Image

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@avivkeller

Copy link
Copy Markdown
Member

I've resolved all the runner failures except for a few on Windows. I'll look at those today, we are going to get this merged!

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@avivkeller

avivkeller commented Feb 26, 2026

Copy link
Copy Markdown
Member

There's quite honestly nothing else that could possibly fail

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 76215dc

@Renegade334

Copy link
Copy Markdown
Member

There's quite honestly nothing else that could possibly fail

A parting gift, then.

image

@Renegade334

Copy link
Copy Markdown
Member

On a serious note, how far back are we intending this to land?

@avivkeller

avivkeller commented Feb 27, 2026

Copy link
Copy Markdown
Member

A parting gift, then.

It's a flake, and is not related to the changes in this PR. The test flaked twice before passing on it's third trial. See #61762

@avivkeller

Copy link
Copy Markdown
Member

On a serious note, how far back are we intending this to land?

The plan is for this to land on all release lines, and immediately replace the existing documentation generation tooling, starting at the next patch release.

@aduh95

Copy link
Copy Markdown
Contributor

There are some regressions in the JSON output (#57343 (comment)), let's not rush the backports

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.baking-for-ltsPRs that need to wait before landing in a LTS release.buildIssues and PRs related to build files or the CI.commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.docIssues and PRs related to the documentations.needs-ciPRs that need a full CI run.notable-changePRs with changes that should be highlighted in changelogs.toolsIssues and PRs related to the tools directory.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

20 participants

@flakey5@nodejs-github-bot@ovflowd@araujogui@mhdawson@Trott@avivkeller@aduh95@jasnell@trivikr@AugustinMauroy@targos@aymen94@mcollina@panva@joyeecheung@Renegade334@lemire@lpinca@anonrig