Skip to content

feat(api): enrich generated configuration page - #198

Merged
bjohansebas merged 3 commits into
mainfrom
bsebas/patch
Jul 21, 2026
Merged

feat(api): enrich generated configuration page#198
bjohansebas merged 3 commits into
mainfrom
bsebas/patch

Conversation

@bjohansebas

@bjohansebas bjohansebas commented Jul 21, 2026

Copy link
Copy Markdown
Member
  • add a webpack.config.js example to every option, derived from the schema (enum literals, required-object expansion, richest-shape preference for multi-shape options)
  • expand sub-options of multi-shape options (e.g. cache) using their richest object shape
  • document shared discriminators as the union of their variants (cache.type: "filesystem" | "memory")
  • mark deprecated options with a "Stability: 0 - Deprecated" banner

Summary

What kind of change does this PR introduce?

Did you add tests for your changes?

Does this PR introduce a breaking change?

If relevant, what needs to be documented once your changes are merged or what have you already documented?

Use of AI

yes!

@bjohansebas
feat(api): enrich generated configuration page
bc2722d 
- add a webpack.config.js example to every option, derived from the
  schema (enum literals, required-object expansion, richest-shape
  preference for multi-shape options)
- expand sub-options of multi-shape options (e.g. cache) using their
  richest object shape
- document shared discriminators as the union of their variants
  (cache.type: "filesystem" | "memory")
- mark deprecated options with a "Stability: 0 - Deprecated" banner
Copilot AI review requested due to automatic review settings July 21, 2026 21:06
Copilot AI reviewed Jul 21, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@vercel

vercel Bot commented Jul 21, 2026 •
edited
Loading

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
webpack-doc-kit Ready Ready Preview, Comment Jul 21, 2026 9:31pm

Request Review

@bjohansebas
bjohansebas marked this pull request as draft July 21, 2026 21:07
@github-actions

github-actions Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

⚡ Lighthouse report

Audited the Vercel preview deployment: https://webpack-doc-8bb836lql-openjs.vercel.app

URL Performance Accessibility Best Practices SEO Report
/ 🟢 90 🟠 88 🟢 96 🟢 100 🔗
/about 🟢 98 🟠 89 🟢 100 🟢 100 🔗
/about/sponsors 🟢 99 🟠 83 🟢 96 🟢 100 🔗
/blog 🟢 99 🟠 86 🟢 100 🟢 100 🔗
/blog/posts/2026-02-04-roadmap-2026 🟢 98 🟠 87 🟢 100 🟢 100 🔗
/guides/getting-started 🟢 96 🟠 89 🟢 100 🟢 100 🔗
/docs/api/v5.x/options 🔴 67 🟠 88 🟢 100 🟢 100 🔗
/docs/loaders/css-loader 🟢 97 🟠 89 🟢 100 🟠 83 🔗

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

@bjohansebas
bjohansebas marked this pull request as ready for review July 21, 2026 21:33
Copilot AI review requested due to automatic review settings July 21, 2026 21:33
Copilot AI reviewed Jul 21, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@bjohansebas

bjohansebas commented Jul 21, 2026

Copy link
Copy Markdown
Member Author

Hmm, I don't think the Lighthouse part is really caused by my changes anymore. It seems to be coming from Doc Kit now

@bjohansebas
bjohansebas requested a review from a team July 21, 2026 21:38
@avivkeller

avivkeller commented Jul 21, 2026

Copy link
Copy Markdown
Member

Hmm, I don't think the Lighthouse part is really caused by my changes anymore. It seems to be coming from Doc Kit now

The size of the page is directly correlated to the size of the JavaScript. It's a doc-kit issue that's on my "fixing this will be great but I have zero idea how".

Might be time for me to stick Codex or Claude on it, we have those tools for a reason :-)

@avivkeller

avivkeller commented Jul 21, 2026

Copy link
Copy Markdown
Member

For what it's worth our JavaScript isn't render blocking, so while it affects performance in Lighthouse, it's not something that the end users will really notice, i.e. a slow machine will not make the page any slower

@bjohansebas

bjohansebas commented Jul 21, 2026

Copy link
Copy Markdown
Member Author

After this, I'm going to start typing webpack defaults so we can show the default values in the documentation.

moshams272
moshams272 approved these changes Jul 21, 2026
View reviewed changes

@moshams272 moshams272 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! Actually, when I worked to improve the lighthouse, I found there is more from doc-kit, so it can be as Aviv mentioned.

@bjohansebas
bjohansebas merged commit d297430 into main Jul 21, 2026
10 of 11 checks passed
@bjohansebas
bjohansebas deleted the bsebas/patch branch July 21, 2026 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments
@moshams272 moshams272 moshams272 approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@bjohansebas @avivkeller @moshams272