Improve Getting Started guide clarity and consistency#8199
Merged
alexander-akait merged 2 commits intowebpack:mainfrom Apr 17, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Member
alexander-akait
left a comment
alexander-akait
left a comment
There was a problem hiding this comment.
Let's fix lint and we can merge
alexander-akait
approved these changes
Apr 17, 2026
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
This PR improves the webpack Getting Started guide by tightening several beginner-facing explanations and correcting outdated examples.
The guide now explains when webpack is useful before asking readers to install it, adds package-manager guardrails so users do not accidentally run npm, yarn, and pnpm commands together, clarifies the project-wide impact of
"type": "module", and explains whydist/is temporary manual scaffolding at this stage of the guide.It also updates outdated dependency/version examples, removes legacy
npm install --saveguidance, clarifies that webpack bundles module graphs rather than generally transpiling JavaScript syntax, and explains why the first build output is minimized by default.What kind of change does this PR introduce?
docs
Did you add tests for your changes?
No runtime tests were added because this PR only changes documentation.
I validated the changed guide with:
npm run lint:markdown -- src/content/guides/getting-started.mdxnpx prettier --check src/content/guides/getting-started.mdxThe repository pre-commit checks also passed for the staged file.
Does this PR introduce a breaking change?
No.
If relevant, what needs to be documented once your changes are merged or what have you already documented?
All relevant changes are already documented in this PR within
src/content/guides/getting-started.mdx.Use of AI
I used AI assistance to help audit the existing guide, draft clearer wording, and prepare the documentation changes. I reviewed the generated changes before committing them and validated the result with the repository’s markdown/prettier checks.