Skip to content

build, doc: move to redesign#62045

Open
avivkeller wants to merge 3 commits intonodejs:mainfrom
avivkeller:doc/redesign
Open

build, doc: move to redesign#62045
avivkeller wants to merge 3 commits intonodejs:mainfrom
avivkeller:doc/redesign

Conversation

@avivkeller
Copy link
Member

@avivkeller avivkeller commented Feb 28, 2026

This PR shouldn't change much from it's current form. Most changes will go in doc-kit. test-make-doc was removed, since our new generator minifies the output HTML (so it's format is structurally inconsistent) and can't be easily parsed with the existing regular expressions.

Furthermore, such tests are not needed due to our tests in doc-kit.

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. windows Issues and PRs related to the Windows platform. labels Feb 28, 2026
@avivkeller avivkeller added wip Issues and PRs that are still a work in progress. blocked PRs that are blocked by other issues or PRs. labels Mar 1, 2026
@avivkeller avivkeller marked this pull request as ready for review March 1, 2026 00:41
Copilot AI review requested due to automatic review settings March 1, 2026 00:41
@avivkeller
Copy link
Member Author

Moving out of draft to test CI.


Blocked by:
#62046
https://github.com/nodejs/doc-kit/milestone/1

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates Node.js doc build configuration to experiment with the redesigned documentation output by switching doc-kit templates away from the legacy “all-in-one HTML” generation.

Changes:

  • Switch doc-kit HTML generation template from legacy-html-all to web (Makefile + Windows build).
  • Stop declaring out/doc/api/all.html as a required/produced doc artifact in the doc-only Makefile target.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
Makefile Uses the web doc-kit template and removes all.html from declared doc build outputs.
vcbuild.bat Uses the web doc-kit template during Windows doc generation.
Comments suppressed due to low confidence (1)

Makefile:838

  • The comment above this doc generation rule still says it generates all.html/all.json, but all.html is no longer a target/output in this rule. Please update the comment to match the new set of generated artifacts to avoid confusion for future maintainers.
# Generate all doc files (individual and all.html/all.json) in a single doc-kit call
# Using grouped targets (&:) so Make knows one command produces all outputs

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Mar 1, 2026

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #62045      +/-   ##
==========================================
+ Coverage   89.58%   89.66%   +0.07%     
==========================================
  Files         674      676       +2     
  Lines      205159   206326    +1167     
  Branches    39352    39519     +167     
==========================================
+ Hits       183792   185000    +1208     
+ Misses      13583    13466     -117     
- Partials     7784     7860      +76     

see 135 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 removed the wip Issues and PRs that are still a work in progress. label Mar 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blocked PRs that are blocked by other issues or PRs. build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. windows Issues and PRs related to the Windows platform.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants