Skip to content

docs: improve CLI documentation clarity#8059

Open
Ash-Misty wants to merge 6 commits intowebpack:mainfrom
Ash-Misty:first-doc-fix
Open

docs: improve CLI documentation clarity#8059
Ash-Misty wants to merge 6 commits intowebpack:mainfrom
Ash-Misty:first-doc-fix

Conversation

@Ash-Misty
Copy link

Improved clarity and readability in CLI documentation.

  • Refined wording for better understanding
  • Improved formatting in some sections

This is my first contribution. Feedback is welcome!

@vercel
Copy link

vercel bot commented Mar 19, 2026

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

Project Deployment Actions Updated (UTC)
webpack-js-org Ready Ready Preview, Comment Mar 19, 2026 4:39pm

Request Review

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 19, 2026

CLA Signed

The committers listed above are authorized under a signed CLA.

@Ash-Misty
Copy link
Author

Hi, I’m preparing for GSoC 2026 and have started contributing to webpack (opened my first PR in the docs repo).

I’m interested in working on improving support for @example tags (#5).
I’ve set up the project locally and started exploring the codebase.

Could you guide me to the relevant files or modules where this transformation is handled?

Thanks!

Copy link
Member

@alexander-akait alexander-akait left a comment

Choose a reason for hiding this comment

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

We have Common Use Cases section, please move it here

Copy link
Member

@alexander-akait alexander-akait left a comment

Choose a reason for hiding this comment

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

A lot of unrelated changed

@Ash-Misty
Copy link
Author

Ash-Misty commented Mar 19, 2026

yeah I got lint errors on the other files now

@Ash-Misty
Copy link
Author

I have made the changes review it

"version": "0.1.2",
"private": true,
"description": "The main site for all things webpack.",
"description": "The main site for all things webpack. - CI fixes applied",
Copy link
Member

Choose a reason for hiding this comment

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

Looks like it is AI generated code

Copy link
Author

Choose a reason for hiding this comment

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

I made a small change in package.json to resolve the CI errors and adjusted the description for readability. Let me know if you'd prefer I keep the change or revert the description update.

@Ash-Misty
Copy link
Author

I made a small change in package.json to resolve the CI errors and adjusted the description for readability. Let me know if you'd prefer I keep the change or revert the description update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants