-
-
Notifications
You must be signed in to change notification settings - Fork 597
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(readme): fix typos, add summary of all commands #845
Conversation
fix typos, add summary of all commands in commands section
README.md
Outdated
@@ -27,7 +27,7 @@ | |||
- [How to install](#how-to-install) | |||
* [Getting Started](#getting-started) | |||
* [webpack CLI Scaffolds](#webpack-cli-scaffolds) | |||
* Commands | |||
* [Commands](#commands) | |||
- [`webpack-cli init`](./packages/init/README.md#webpack-cli-init) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we still keep all list of commands here? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the new one, I would remove this 👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Removing, let's see how everyone else finds it :)
Thank you for your pull request! The most important CI builds succeeded, we’ll review the pull request soon. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well done! Would be nice to have a summary of the other packages like webpack-scaffold, generators and util that aren't mentioned here. What do you think? :)
README.md
Outdated
@@ -27,7 +27,7 @@ | |||
- [How to install](#how-to-install) | |||
* [Getting Started](#getting-started) | |||
* [webpack CLI Scaffolds](#webpack-cli-scaffolds) | |||
* Commands | |||
* [Commands](#commands) | |||
- [`webpack-cli init`](./packages/init/README.md#webpack-cli-init) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the new one, I would remove this 👍
remove commands list from the beginning
@anshumanv Thanks for your update. I labeled the Pull Request so reviewers will review it again. @misterdev Please review the new changes. |
@misterdev since (utils, generators, webpack-scaffold) packages are just helpers to other packages and don't have a real command so I'm not sure if it's the best idea to list them in the |
Yeah, I would make another list e.g. "Packages" after the "Commands" section :) Packages
IMO, having a complete overview of the repository in the REAME is something desirable PS: I can work on this, in case it is not in the scope of this PR or you have something else to do :) |
include util packages
Sounds good @misterdev, just a trivial change. ✨ |
fix typos, add summary of all commands in commands section
What kind of change does this PR introduce?
docs
Did you add tests for your changes?
NA
If relevant, did you update the documentation?
Yes
Summary
Does this PR introduce a breaking change?
No
Other information
NA