Skip to content

Brief summary for all webpack-contrib/*-loaders #805

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
simon04 opened this issue Feb 3, 2017 · 4 comments
Closed

Brief summary for all webpack-contrib/*-loaders #805

simon04 opened this issue Feb 3, 2017 · 4 comments
Labels

Comments

@simon04
Copy link
Collaborator

simon04 commented Feb 3, 2017

I would like to have every webpack-contrib/*-loader repository a brief summary what the corresponding loader does. The text could be obtained from https://github.com/webpack/webpack/blob/2ed6448/README.md#loaders or #804.

For one example, see webpack-contrib/css-loader#404.

Any thoughts? How to concertedly reach all ≈30 loaders?

@skipjack
Copy link
Collaborator

@simon04 do you mean in each making sure each loaders readme has a clear description/introduction (as discussed in #1161)? Or do you mean summaries that can be parsed out and displayed somewhere like /content/loaders/index.md?

@skipjack
Copy link
Collaborator

We could also grab the little description at the top of every github repo:

image

The advantage to this is that it's already separate within github so it's probably easier to grab than having to enforce a readme standard and parse it out of every readme.

@skipjack
Copy link
Collaborator

skipjack commented May 27, 2017

Ah ok just re-read the initial comment and jumped through the links, so you're not even talking about having a parsed out description available here... it's more just making sure the readme of every loader has one? If so, is this closed with our work on #1161 and #1254? If there are there any left to tackle, I'd be glad to help.

I do think the place I highlighted in the above comment would be a good location (as well as in the readme) for clear, concise descriptions, especially because they should be easy to parse out and dynamically display in a table or something similar.

@skipjack
Copy link
Collaborator

skipjack commented Jun 3, 2017

Closing due to inactivity... please re-open with answers to the questions above if this is still an issue. @simon04 I'd be glad to help with these if there are still any left that don't have good descriptions however I still think creating issues on the actual repos that lack the content makes more sense and will be easier to push forward (although maybe I'm still not understanding the actual issue).

@skipjack skipjack closed this as completed Jun 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants