jonschlinkert / grunt-readme

DEPRECATED. Use Verb instead
https://github.com/assemble/verb
Other
30 stars 10 forks source link

docs vs templates #3

Closed dylang closed 10 years ago

dylang commented 10 years ago

I'm confused about the difference between docs and templates. They both mention "includes", the quotes is throwing me off.

My thinking was that templates is where templates are loaded from when using _.include and docs is where the processed templates are saved as user documentation.

jonschlinkert commented 10 years ago

You are correct on just about everything. I'll try to clarify in the docs (and perhaps by renaming the templates dir to includes).

The main reason for both existing is that you might want to use a combination of templates/docs from two different locations or sources.

If you have any ideas on how to make this more clear or easier to understand I'm completely open, I love the feedback so please keep it coming :-)