Back to webpack
GSoC 2026

webpack: New Documentation Website - Completing the TypeDoc Pipeline for webpack's API

The Problem When developers write custom webpack plugins, they need reliable API documentation. Currently, the generated docs drop critical function signatures, returning unhelpful {object} types instead of actual parameters. The new documentation infrastructure is also missing webpack's visual identity, essential navigation pages, and a safe review process for automated updates. The Solution I will complete the TypeDoc to doc-kit pipeline to finalize webpack's API documentation redesign. First, I will fix the AST renderers to properly map TypeScript function overloads so no signature data is lost. Then, I will configure the doc-kit UI with webpack brand tokens and build custom React components to cleanly display complex hooks. Finally, I will secure the CI/CD workflow and port the core website pages. Deliverables: Accurate API Output: A fixed TypeDoc theme that correctly renders function parameters and TypeScript overloads. Visual Identity: A custom doc-kit configuration with webpack branding and new React components (HookSignature, PluginInterface, DeprecationBanner). Automated CI/CD: A GitHub Actions workflow that safely opens pull requests for new docs instead of pushing directly. Core Navigation: Fully ported Home, Download, Guides, and About pages.

Project details

Contributor

ryzrr

Mentors

Not available

Technologies

Not listed in the archive