Skip to content

Link to concepts from guides (or maybe rename some things?) #442

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

Closed
dmitriid opened this issue Nov 26, 2016 · 1 comment
Closed

Link to concepts from guides (or maybe rename some things?) #442

dmitriid opened this issue Nov 26, 2016 · 1 comment

Comments

@dmitriid
Copy link
Contributor

dmitriid commented Nov 26, 2016

Very few, if any, beginners (or even more advanced users) will go to the concepts page. Quite often "concepts" pages describe white papers, or system architecture, or some other deeply technical and/or philosophical thing.

People will be almost immediately drawn to the guides section, as they will expect the guides to be a gentle/easy/simple introduction and walkthrough to the system.

However, https://webpack.js.org/concepts/ is a very good starting point. It actually has a gentle introduction and keeps on explaining various things while being very gentle. At the same time the guides section is frankly intimidating. It dumps a lot of advanced stuff on you with little to no explanation of, well, concepts.

IMO:

  • "concepts" should be renamed to "guides"/"guide"
  • "guides" should be renamed to "in-depth guides" or "handbook"

or

  • concepts should be linked to from guides prominently, in every guide

Comparisons:

Rollup

Rollup's guide goes in baby steps from explaining what it is, to creating a first bundle, to plugins etc. I would say it basically mirrors what webpack calls concepts.

Browserify

Their documentation is not in as good a shape, but what webpack calls guides is essentially called a handbook

Gulp

A horrible mess of recipes basically correspond to webpack's guides.

etc.

@dmitriid
Copy link
Contributor Author

Closing this in favour of #749

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

No branches or pull requests

1 participant