docs(packages): add missing READMES to packages#545
Conversation
|
@ev1stensberg The most important CI builds failed. This way your PR can't be merged. Please take a look at the CI results from travis (failure) and fix these issues. |
|
But Ci failed? 😅 |
|
And not reviewed 🤔 |
|
CI is @dhruvdutt s task |
ematipico
left a comment
ematipico
left a comment
There was a problem hiding this comment.
Overall looks fine but the commands are all mixed, which could lead to confusion to the end user. We should cover always local and global usage/installation
| ## Description | ||
|
|
||
| This package contains the logic to add new properties to the a webpack configuration file. It will run a generator that prompts the user for questions of which property to add to their webpack configuration file. | ||
| This package contains the logic to add new properties in a webpack configuration file. It will run a generator that prompts the user for questions of which property to add to their webpack configuration file. |
There was a problem hiding this comment.
the user some question about which properties to add
|
|
||
| ## Description | ||
|
|
||
| This package contains the logic to initiate new loader projects. |
There was a problem hiding this comment.
initiate => create
Simpler wording
|
|
||
| ### CLI (via `webpack-cli`) | ||
| ```bash | ||
| npx webpack-cli generate-loader |
There was a problem hiding this comment.
We should always split installation and usage of the packages in local and global:
npx webpack-cli generate-loaderand
webpack-cli generate-loaderIn this file we mixed, which is confusing for the user
|
|
||
| ## Description | ||
|
|
||
| This package contains the logic to initiate new plugin projects. |
|
|
||
| ## Description | ||
|
|
||
| This package contains all webpack-cli related yeoman generators. |
There was a problem hiding this comment.
We should explain what the generators do
|
|
||
| ## Description | ||
|
|
||
| This package contains the logic to remove properties of a webpack configuration file. It will run a generator that prompts the user for questions of which property to remove in their webpack configuration file. |
There was a problem hiding this comment.
the user some question about which
|
@ev1stensberg left some comments about some changes. Unfortunately this is already been merged (don't know why). |
|
Submit a PR with patch label @ematipico |
ghost
mentioned this pull request
4 participants
What kind of change does this PR introduce?
Enhancement
Did you add tests for your changes?
N/A
If relevant, did you update the documentation?
Yes
Summary
Adds README files to all our mono repo packages
Does this PR introduce a breaking change?
no
Other information
=)