-
-
Notifications
You must be signed in to change notification settings - Fork 35k
Conversation
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.
|
Moving out of draft to test CI. Blocked by: |
There was a problem hiding this 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-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 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 New features to boost your workflow:
|