search

TheLarkInn / artsy-webpack-tour

Annotations on webpack source code in a pseudo-guided fashion.
524 stars 34 forks source link

Suggestion: Add searchable text & linkable headings #5

Open spen opened 7 years ago

spen commented 7 years ago

Hi @TheLarkInn! I'm enjoying the repo - great to see an explanation of the inner workings of Webpack!

I'm wondering if there's any value in transcribing the annotations to text below each image? It could just add a lot of extra noise but would make the readme searchable (using find etc.)

Along the same lines - a heading or some sort of quick, linkable reference could be helpful for sharing direct links to particular sections or images.

I just wanted to throw these ideas out to you, I'm not sure much they would help or hinder other folks reading the readme :)

TheLarkInn commented 7 years ago

I would humbly and gratefully accept PR'S in whatever format you feel best for a feature like this.

Troesler95 commented 6 years ago

Hi guys! Love this repo, it houses a lot of great information for the flow of Webpack.

It is a bit hard to follow in my opinion though, so I was thinking of reformatting it such that the annotated text and headers are with the images that they correlate to.

For example:

WebpackOptionsApply.js (List of plugins)

image

"All plugins for options cases"
"These handle any module format"

for each of the images and annotations.

I also think that a table of contents would help readers who might be using this to reference specific files utilize this repo more effectively rather than trying to remember where that image is in the list.

Thoughts?

TheLarkInn commented 6 years ago

I'm more then happy to accept any PRs for this that make it easier.