build, doc: move to redesign#62045
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
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-alltoweb(Makefile + Windows build). - Stop declaring
out/doc/api/all.htmlas a required/produced doc artifact in thedoc-onlyMakefile 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, butall.htmlis 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 Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #62045 +/- ##
==========================================
- Coverage 90.06% 90.05% -0.01%
==========================================
Files 714 714
Lines 225629 225629
Branches 42702 42679 -23
==========================================
- Hits 203211 203192 -19
+ Misses 14232 14222 -10
- Partials 8186 8215 +29 🚀 New features to boost your workflow:
|
Signed-off-by: avivkeller <me@aviv.sh>
|
The
notable-change
Please suggest a text for the release notes if you'd like to include a more detailed summary, then proceed to update the PR description with the text or a link to the notable change suggested text comment. Otherwise, the commit will be placed in the Other Notable Changes section. |
|
cc @nodejs/build @nodejs/web-infra @nodejs/TSC for reviews |
|
Can't quite verify. |
|
@panva Sorry! I'm still trying to get the thread count to work on all CI machines, but the output from https://github.com/nodejs/node/actions/runs/25992332792?pr=62045 's artifacts have the generated docs. A lot of the runners use slim machines, which it appears interfere with the generation, so I need to see which CI checks fail. |
|
@avivkeller footnotes don't seem to work, I don't know if it's being tracked or not but leaving that here, also don't know if they don't work generally or as a side effect of the bundle here. There are 100% docs where this is an improvement and it will take some getting used to. Very subjective. Some oddities I notice upon first (well, first this time around) look, take it with a grain of salt, I'm very used to the old docs and it's easy to focus on what stands out really quickly. In that way I hope this might be valuable (non-blocking) feedback.
|
AugustinMauroy
left a comment
There was a problem hiding this comment.
what about the documentation.md file ? we should remove it but there are a blocker with that the explaining of the stability level will be lost






This PR shouldn't change much from it's current form. Most changes will go in
doc-kit.test-make-docwas 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.
Notable Change:
Node.js is thrilled to announce a brand new redesign of our documentation experience! The updated documentation now features HTML structure and styling that are much more closely aligned with the main Node.js website UI, creating a more consistent experience across the brand. You can check out the redesigned documentation today at https://nodejs.org/api.