chore: use doc-kit typedoc plugin by avivkeller · Pull Request #293 · webpack/webpack-doc-kit

avivkeller · 2026-10-29T19:29:37Z

As titled

Summary by CodeRabbit

Documentation
- API documentation now includes an overview index and a sidebar organized by API type, with nested namespace pages and links to Options.
- Source links in API docs now point to matching JavaScript implementation locations when available.
- Versioned documentation links to its published version, and edit links are not shown when no edit URL is available.
Bug Fixes
- The Contribute link now appears only when a valid edit-page destination is available.

vercel · 2026-10-29T19:29:42Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
webpack-doc-kit	Ready	Preview	Oct 29, 2026 7:37pm UTC

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

socket-security · 2026-10-29T19:34:41Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	@doc-kit/typedoc@0.0.0

View full report

coderabbitai · 2026-10-29T19:34:45Z

Walkthrough

The API documentation build now uses doc-kit’s TypeDoc integration and adds plugins for reflection handling and JavaScript source links. The generator writes API sidebar and index files from generated pages. The changes also remove the previous custom TypeDoc processor and theme implementation, update versioned documentation settings, and conditionally render the Contribute item.

Priority: Pending latest changes

Merge Risk: High · up to 865f2

The API documentation build depends on a local filesystem package that fresh clones and CI do not have, so it would fail until the package is published and referenced by version. Versioned API source links would also target an invalid Git ref. Resolve the dependency before merging.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title "chore: use doc-kit typedoc plugin" matches the main change. The package.json now adds the local `@doc-kit/typedoc` dependency, and scripts/markdown/api/utils.mjs imports load from `@doc-kit/ty`…
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Full details: Title check

Explanation

The title "chore: use doc-kit typedoc plugin" matches the main change. The package.json now adds the local @doc-kit/typedoc dependency, and scripts/markdown/api/utils.mjs imports load from @doc-kit/typedoc into typeDocConfig. The changeset also removes the custom processor, theme, and router plugins, which the new plugin replaces. The title is short, specific, and uses a conventional commit prefix. It does not mention the large removal of local TypeDoc plugin code, which is a secondary aspect of the change.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 1 functions across 9 files. (1 skipped: 1 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches: 💡 2

📝 Generate docstrings: 💡

Commit to this branch
Create a new PR

🛠️ Fix failing CI checks: 💡

Commit to this branch
Create a new PR

🧪 Generate unit tests (beta)

Commit to this branch
Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 2

Nitpick comments: 1

plugins/sources.mjs: 1

3-3: Trivial · Stability & Availability · Quick win

Declare typescript as a direct dependency.

plugins/sources.mjs imports typescript at runtime. The package.json dependency lists in the supplied context do not include it. The import currently resolves only because typedoc lists it as a peer dependency, and npm hoists and auto-installs peers. A stricter linker such as pnpm, or a change in hoisting, would break the API build with ERR_MODULE_NOT_FOUND.

Add typescript to dependencies, or to devDependencies if the build only runs from a full install.

Review info

Run configuration

Source mode: Auto
Repository: Unavailable
Branch: Unavailable
File: No configuration file from this repository applied
Commit: Unavailable
Layers: Organization UI
Review profile: CHILL
Plan: Advanced
Run ID: eba9b563-6253-4b87-b803-6fd22b6c65b5

Commits

Reviewing files that changed from the base of the PR and between 17126e1 and 865f268.

Files ignored due to path filters: 1

package-lock.json is excluded by !**/package-lock.json

Files selected for processing: 30

components/MetaBar/index.jsx
package.json
plugins/processor/exportEquals.mjs
plugins/processor/extractHooksGroup.mjs
plugins/processor/index.mjs
plugins/processor/metadata.mjs
plugins/processor/ownership.mjs
plugins/processor/router.mjs
plugins/processor/site.mjs
plugins/processor/source.mjs
plugins/processor/synthetic.mjs
plugins/processor/typeMap.mjs
plugins/shared/categories.mjs
plugins/shared/titles.mjs
plugins/sources.mjs
plugins/theme/helpers/index.mjs
plugins/theme/index.mjs
plugins/theme/partials/index.mjs
plugins/theme/partials/types.mjs
plugins/webpack.mjs
scripts/html/doc-kit.config.mjs
scripts/markdown/api/index.mjs
scripts/markdown/api/sidebar.mjs
scripts/markdown/api/typedoc-hooks.mjs
scripts/markdown/api/utils.mjs
tests/sidebar.test.mjs
tests/theme/fixtures/input.js
tests/theme/fixtures/tsconfig.json
tests/theme/theme.test.mjs
tests/theme/theme.test.mjs.snapshot

Files with no reviewable changes: 20

tests/theme/fixtures/tsconfig.json
tests/theme/fixtures/input.js
plugins/shared/categories.mjs
plugins/theme/partials/index.mjs
plugins/processor/ownership.mjs
tests/theme/theme.test.mjs.snapshot
plugins/processor/exportEquals.mjs
plugins/processor/index.mjs
plugins/processor/typeMap.mjs
tests/theme/theme.test.mjs
plugins/processor/site.mjs
plugins/processor/extractHooksGroup.mjs
plugins/processor/source.mjs
plugins/theme/partials/types.mjs
plugins/processor/synthetic.mjs
plugins/processor/router.mjs
plugins/processor/metadata.mjs
plugins/theme/helpers/index.mjs
plugins/shared/titles.mjs
plugins/theme/index.mjs

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

linux-foundation-easycla · 2026-10-29T19:36:07Z

✅ Unknown (db12a79)
✅ login: avivkeller / name: Aviv Keller (340c63f)
✅ login: avivkeller / name: avivkeller (865f268, db12a79)
❌ - login: @coderabbitai[bot] / name: coderabbitai[bot]. The commit (340c63f) is not authorized under a signed CLA. Please click here to be authorized. For further assistance with EasyCLA, please visit our EasyCLA portal and chat with our support bot.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

Anything <id+login@users.noreply.github.com> - it will locate your GitHub user by id part.
Anything <login@users.noreply.github.com> - it will locate your GitHub user by login part.
Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Alternatively, if the co-author should not be included, remove the Co-authored-by: line from the commit message.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

github-actions · 2026-10-29T19:58:04Z

⚡ Lighthouse report

Audited the Vercel preview deployment: https://webpack-doc-6ywnjr0gg-openjs.vercel.app

URL	Performance	Accessibility	Best Practices	SEO	Report
/	🟢 99	🟢 100	🟢 100	🟢 100	🔗
/about	🟢 100	🟢 96	🟢 100	🟢 100	🔗
/about/sponsors	🟠 85	🟢 95	🟢 100	🟢 100	🔗
/blog	🟢 100	🟢 96	🟢 100	🟢 100	🔗
/blog/posts/2026-02-04-roadmap-2026	🟢 100	🟢 93	🟢 100	🟢 100	🔗
/guides/getting-started	🟢 100	🟢 95	🟢 100	🟢 100	🔗
/docs/api/options	🔴 69	🟢 96	🟢 100	🟢 100	n/a
/docs/loaders/sass-loader	🟢 100	🟢 96	🟢 100	🟠 86	🔗

Scores are advisory (warn at 90); they do not fail the build. See .lighthouserc.json.

chore: use doc-kit typedoc plugin

865f268

vercel Bot had a problem deploying to Preview October 29, 2026 19:29 Failure

github-actions Bot added dependencies Pull requests that update a dependency file theme tooling tests Pull requests that update tests labels Oct 29, 2026

fixup! chore: use doc-kit typedoc plugin

db12a79

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

coderabbitai Bot reviewed Oct 29, 2026

View reviewed changes

Comment thread package.json Resolved

Comment thread scripts/html/doc-kit.config.mjs Resolved

vercel Bot deployed to Preview October 29, 2026 19:35

View deployment

Update scripts/html/doc-kit.config.mjs

340c63f

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

avivkeller merged commit 793bb9e into main Oct 29, 2026
10 of 12 checks passed

avivkeller deleted the doc-kit/typedoc branch October 29, 2026 19:36

vercel Bot deployed to Preview October 29, 2026 19:37

View deployment

Navigation Menu

Repository navigation

chore: use doc-kit typedoc plugin - #293

chore: use doc-kit typedoc plugin#293
avivkeller merged 3 commits into
mainfrom
doc-kit/typedoc

avivkeller commented Oct 29, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Oct 29, 2026 •

edited

Loading

Uh oh!

socket-security Bot commented Oct 29, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Oct 29, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

Uh oh!

linux-foundation-easycla Bot commented Oct 29, 2026

Uh oh!

Uh oh!

github-actions Bot commented Oct 29, 2026

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

avivkeller commented Oct 29, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel Bot commented Oct 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security Bot commented Oct 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Oct 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

linux-foundation-easycla Bot commented Oct 29, 2026

Uh oh!

Uh oh!

github-actions Bot commented Oct 29, 2026

⚡ Lighthouse report

Uh oh!

This branch was successfully deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

avivkeller commented Oct 29, 2026 •

edited by coderabbitai Bot

Loading

vercel Bot commented Oct 29, 2026 •

edited

Loading

socket-security Bot commented Oct 29, 2026 •

edited

Loading

coderabbitai Bot commented Oct 29, 2026 •

edited

Loading