feat: adopt upstream doc-kit prerequisites for webpack integration (#13)#62
Closed
soumyarajbag wants to merge 1 commit intowebpack:mainfrom
Closed
feat: adopt upstream doc-kit prerequisites for webpack integration (#13)#62soumyarajbag wants to merge 1 commit intowebpack:mainfrom
soumyarajbag wants to merge 1 commit intowebpack:mainfrom
Conversation
|
|
soumyarajbag
force-pushed
the
feat/upstream-prerequisites
branch
from
aa84d34 to
2c51cc9
Compare
Member
|
We aren't accepting PRs for milestone 1 at the moment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Resolves #13 — three of the four upstream nodejs/doc-kit prerequisites for webpack's
production adoption have now been merged and released. This PR updates the dependency and
wires up the newly available capabilities.
#668. Generic types like {Set}, {Map<string, RegExp>}, {Iterable<Module, any,
any>} (which appear extensively in the generated webpack API pages) now resolve to
properly linked Markdown.
PR #677. Introduces #theme/Logo, #theme/Navigation, #theme/Sidebar, #theme/Footer, and
#theme/Layout aliases that consuming projects can override via web.imports in their
config.
via PR #672. Output files now mirror the input glob's directory hierarchy instead of
being flattened.
nodejs/doc-kit#332 (Generification) remains open as a long-term goal and is not addressed
here.
What kind of change does this PR introduce?
feat — dependency update + new webpack-specific Logo component + configuration of the
custom theming layer.
Did you add tests for your changes?
No. The changes are a dependency bump, a config update, and a UI component. The theming
override can be validated visually by running npm run build-html.
Does this PR introduce a breaking change?
No. The web.imports block is additive and only affects the #theme/Logo alias. All other
theme components continue to use their built-in defaults.
If relevant, what needs to be documented once your changes are merged or what have you
already documented?
The web.imports keys (#theme/Navigation, #theme/Sidebar, #theme/Footer, #theme/Layout)
remain available for future customization in Milestone 2, when the webpack visual design
is finalized. No additional documentation is required at this stage.
Use of AI
Claude (claude-sonnet-4-6 via Claude Code CLI) was used to assist with researching the
upstream PRs, understanding the doc-kit configuration schema, and generating the initial
implementation. All generated code was reviewed, verified against the installed source,
and formatted with Prettier before committing, in accordance with the webpack AI policy https://github.com/webpack/governance/blob/main/AI_POLICY.md).