Skip to content

build, doc: move to redesign#62045

Open
avivkeller wants to merge 5 commits into
nodejs:mainfrom
avivkeller:doc/redesign
Open

build, doc: move to redesign#62045
avivkeller wants to merge 5 commits into
nodejs:mainfrom
avivkeller:doc/redesign

Conversation

@avivkeller
Copy link
Copy Markdown
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.

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.

@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

This comment was marked as outdated.

Copy link
Copy Markdown

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.

Comment thread Makefile Outdated
Comment thread vcbuild.bat
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.05%. Comparing base (a9b0a83) to head (ff070d0).
⚠️ Report is 1 commits behind head on main.

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     

see 48 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
@avivkeller avivkeller removed the blocked PRs that are blocked by other issues or PRs. label May 17, 2026
Signed-off-by: avivkeller <me@aviv.sh>
@avivkeller avivkeller added the notable-change PRs with changes that should be highlighted in changelogs. label May 17, 2026
@github-actions
Copy link
Copy Markdown
Contributor

The notable-change PRs with changes that should be highlighted in changelogs. label has been added by @avivkeller.

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.

@avivkeller
Copy link
Copy Markdown
Member Author

cc @nodejs/build @nodejs/web-infra @nodejs/TSC for reviews

@panva
Copy link
Copy Markdown
Member

panva commented May 17, 2026

Can't quite verify.

➜  node git:(main) gh pr checkout 62045
Switched to branch 'doc/redesign'
➜  node git:(doc/redesign) make doc-only
mkdir -p out/doc/api
cp -r doc/api out/doc

added 374 packages in 2s
error: too many arguments for 'generate'. Expected 0 arguments but got 1.
make: *** [out/doc/api/addons.html] Error 1

@avivkeller
Copy link
Copy Markdown
Member Author

avivkeller commented May 17, 2026

@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.

@panva
Copy link
Copy Markdown
Member

panva commented May 17, 2026

@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.

  • method parameters/arguments are "attributes"? seems odd
  • toc for method lists is barely parseable, consider having toc entries for methods only have the module.method(), i.e. don't list the potentially very long list of parameters
  • non-heading main content switching between 14px and 16px font sizes - my poor brain can't grok this, i know there's just two sizes but because it's jumping around the two all over the place it feels inconsistent, eventho it is.
  • what do you suggest to use in place of tables? the content width is just too tiny to fit any meaningful table.
  • because the old class/property lists used a mix if no-background: Class: Name and class.property it was easy to see you're moving on. Now with just [C] and [P] but otherwise same style (and a 2px font size diff, ...) not so much, it sort of blends all together.
what old new
toc tocold tocnew
table tableold tablenew
interface list interfacesold interfacesnew

Copy link
Copy Markdown
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

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

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

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

Labels

build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. notable-change PRs with changes that should be highlighted in changelogs. windows Issues and PRs related to the Windows platform.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants