Webpack-cli: [Docs]: Update README and Contributing guidelines

[fokusferit]

Updated list of things I will cover:

• [x] Migrate documentation
• [ ] CLI descriptions at webpack.js.org and in the CLI should be more descriptive
• [x] README in all the package folders for each package
• [ ] InIt documentation at webpack.js.org
• [ ] Documentation and Contribution guide
• [ ] Explaination about publishing and the next/develop branch
• [ ] Explain empty params code style

[evenstensberg]

For the contribution guides, it should be split into sections like: do you want to make an easy contribution or an advanced one. At the start, we could have a small summary, and maybe split it up into a menu with pointers to different guides. One could be tests, another AST et.al

[dhruvdutt]

@ev1stensberg Can we add "help wanted", "Good First Contribution" tags?

[evenstensberg]

This is an maintainer issue, cause we need to make sure that the structure and documentation reflects how we want people to contribute. Discussed this in a meeting, @fokusferit can give you the link

[evenstensberg]

@fokusferit any update? 💯

[evenstensberg]

Moving #450 here

[evenstensberg]

So here's what needs attention:

1. Migrate documentation

2. InIt documentation at webpack.js.org

3. CLI descriptions at webpack.js.org and in the CLI should be more descriptive

4. README in all the package folders for each package

5. Documentation and Contribution guide

6. Explaination about publishing and the next/develop branch

[fokusferit]

I'm updating the initial comment, and create a checklist, so that I it's easier to reference to PR's for each task.

[rishabh3112]

@ev1stensberg I would like to work on Init documentation first.

[evenstensberg]

Go for it!

[rishabh3112]

@ev1stensberg check #547 for init documentation

[rishabh3112]

@ev1stensberg how to add documentation to webpack.js.org to complete this task

[evenstensberg]

Any update here lads?

[evenstensberg]

@ematipico @fokusferit it would be really nice if you guys dedicated some time to work on this! ❤️

[fokusferit]

THis weekend I have planned to focus! It's scheduled!

[evenstensberg]

Hmu if you need help @fokusferit

[rishabh3112]

@ev1stensberg having a documentation website is much better as it will serve the cause quicker.
If you agree to same I am happy to build a solution for this :D

[fokusferit]

Docs page is webpack.js.org so stuff needs to go there 😅

[rishabh3112]

Yeah but I couldn't find the docs for webpack-cli there.

[fokusferit]

Exactly. This is something this task should tackle.
We can collaborate on this, as I start with that topic and we could share tasks. Are you

[rishabh3112]

https://cli.angular.io
Angular CLI has its own too ;)

[rishabh3112]

@fokusferit we will be doing this at https://webpack.js.org or a standalone?

[fokusferit]

@rishabh3112 they have it but in our case I think the CLI is an integral part so having them all in one place makes more sense & referencing to the CLI in that doc's will increase visibility :)

[webpack-bot]

This issue had no activity for at least half a year.

It's subject to automatic issue closing if there is no activity in the next 15 days.

[chaytanyasinha]

@evenstensberg May I work on this?

[webpack-bot]

This issue had no activity for at least half a year.

It's subject to automatic issue closing if there is no activity in the next 15 days.

[webpack-bot]

Issue was closed because of inactivity.

If you think this is still a valid issue, please file a new issue with additional information.