DEV Community

Mohamed Shams El-Deen
Mohamed Shams El-Deen

Posted on

Redesigning Webpack's Documentation: My GSoC 2026 Journey

Hello, World! πŸ˜…

I am participating in Google Summer of Code (GSoC) 2026, working with the Webpack to completely redesign it's Documentation.

Description

Webpack is an industry-standard JavaScript module bundler used by millions of developers to build modern web applications. It plays a foundational role in today’s frontend ecosystem and is commonly used in projects built with frameworks such as React, Vue, Angular, and many others.

Problem

Webpack’s code changes a lot. Every time a developer writes or changes an API, someone from the team has to update the webpack documentation manually.

Solution

So, we will build an automated tool using GitHub Actions (that works as CI/CD and update documentation automatically), taking the advantage of the TypeScript compiler (that gives us APIs in types.d.ts), the typedoc-plugin-markdown (that converts TypeScript APIs to markdown), and the Node.js tool doc-kit (that adds links and customized UI).

The Roadmap

From the previous few months, I started tackling 5 major milestones:

M1: Completing the custom TypeDoc theme for accurate Markdown generation.

M2: Customizing the doc-kit output and UI components to match Webpack's brand.

M3: Building an end-to-end CI/CD automation pipeline.

M4: Implementing core pages (Home, Download, Guides).

M5: Expanding automation to fetch Loader and Plugin READMEs dynamically.

What is this series about?

I created this series to document my journey. No boring updates or simple typo fixes. I will write about the complex, interesting, and architecturally significant Pull Requests.

Wait for the first PR πŸ”₯

Top comments (0)