Skip to content
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

Devs - More complex examples added to upgrade path and configurations #1797

Closed
knitcodemonkey opened this issue Jan 20, 2018 · 2 comments
Closed

Comments

@knitcodemonkey
Copy link

I would very much like to see more complex examples highlighting how each configuration could be used in the plugins and modules sections. The simple examples do cover a lot of what most people need, but as soon as there is an additional config required, that info becomes very difficult to find.

@skipjack
Copy link
Collaborator

skipjack commented Jan 21, 2018

Holy moly, you went on an issue binge!

The simple examples do cover a lot of what most people need, but as soon as there is an additional config required, that info becomes very difficult to find.

This is kind of the point. Our Guides section does a fair amount of hand-holding through the core features but then the idea is to point users to next steps and relevant reference-like docs for users to dig deeper. Webpack's API is far too broad and far-reaching for us to maintain highly detailed examples for every feature. We already have 20+ guides and those take time to maintain and keep up to date (plus we're trying to clean up the other sections).

If you notice that particular features are undocumented, please feel free to submit a PR that adds the missing bits. Or if you feel a section is written poorly or could use one more example, please submit a change to resolve it. However, please note that we don't have plans to significantly expand the Guides section of the site or add guide-like diffs throughout the rest of the site. Much of the rest of the site (e.g. API, Configuration, Plugins, and Loaders) is all intended to be reference-like documentation.

Note that we are still working on some of the sections that are still somewhat unorganized and imcomplete (i.e. API). See #1754 and the next branch for more on where we plan to take things when webpack v4 is released.

As it stands right now, this issue is way too broad to be actionable -- and I'm not sure what your requesting is the direction we want to take the site. Feel free to continue the discussion but I'm closing as I don't think we can address this.

If you have specific examples of missing docs, please list them and I'll consider re-opening.

@knitcodemonkey
Copy link
Author

I did go on a bit of an issue binge. I can see your point with this item being too broad to be actionable. I feel that my specific concern could have been handled as part of the upgrade paths section requested in a different issue. Thank you for spending the time to explain.

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

No branches or pull requests

2 participants