Skip to content

build, doc: generate node.1 with doc-kit#62044

Open
avivkeller wants to merge 3 commits intonodejs:mainfrom
avivkeller:generate-node.1-with-doc-kit
Open

build, doc: generate node.1 with doc-kit#62044
avivkeller wants to merge 3 commits intonodejs:mainfrom
avivkeller:generate-node.1-with-doc-kit

Conversation

@avivkeller
Copy link
Member

@avivkeller avivkeller commented Feb 28, 2026

We recently moved node to build with doc-kit, the new tooling for documentation. doc-kit also provides a man-page generator, which PR changes core to use.

The tests for this generator are here, and as such, do not need to exist in this repository.

cc @nodejs/web-infra

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/build
  • @nodejs/config
  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added lib / src Issues and PRs related to general changes in the lib or src directory. needs-ci PRs that need a full CI run. labels Feb 28, 2026
@avivkeller avivkeller marked this pull request as ready for review February 28, 2026 17:32
@avivkeller avivkeller added doc Issues and PRs related to the documentations. build Issues and PRs related to build files or the CI. cli Issues and PRs related to the Node.js command line interface. and removed lib / src Issues and PRs related to general changes in the lib or src directory. labels Feb 28, 2026
@aduh95
Copy link
Contributor

aduh95 commented Feb 28, 2026

The tests for this generator are here, and as such, do not need to exist in this repository.

I disagree, I think there's value in having tests on this repo so we can confidently approve updates or even that PR.

@avivkeller
Copy link
Member Author

I disagree, I think there's value in having tests on this repo so we can confidently approve updates or even that PR.

Noted. I'll move the tests into the doctool tests, and test them with the rest of the documentation generator

@avivkeller avivkeller requested a review from aduh95 February 28, 2026 17:47
@codecov
Copy link

codecov bot commented Feb 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.64%. Comparing base (6a3d358) to head (f896722).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #62044      +/-   ##
==========================================
+ Coverage   89.58%   89.64%   +0.06%     
==========================================
  Files         674      676       +2     
  Lines      205159   206240    +1081     
  Branches    39352    39510     +158     
==========================================
+ Hits       183792   184894    +1102     
+ Misses      13583    13465     -118     
- Partials     7784     7881      +97     
Files with missing lines Coverage Δ
src/node_options.cc 76.22% <ø> (+0.02%) ⬆️

... and 127 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.

@avivkeller avivkeller added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 28, 2026
@nodejs-github-bot
Copy link
Collaborator

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. build Issues and PRs related to build files or the CI. cli Issues and PRs related to the Node.js command line interface. doc Issues and PRs related to the documentations. needs-ci PRs that need a full CI run.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants