application-shell icon indicating copy to clipboard operation
application-shell copied to clipboard

Add comments clarifying what files do

Open owencm opened this issue 10 years ago • 2 comments

There is a lot of stuff going on in this repo. I think it would be really helpful to have at least a few sentences at the start of files such as Dockerfile, app.yaml and gulpfile.js (and probably many other files) to clarify what they do.

I think that would really help people trying to orient their way around this and work out what to modify / rip out for their own variation.

owencm avatar Dec 04 '15 21:12 owencm

Agree completely. I think an appendix walking through the responsibilities of our different files (or comments in files) would be valuable.

addyosmani avatar Dec 06 '15 22:12 addyosmani

Would there be value in us having an appendix.md file that walks through what each directory / roughly what the important files in the repo correspond to? (cc @gauntface for his thoughts too)

addyosmani avatar Jan 12 '16 11:01 addyosmani