Configuration motivation

[flut1]

When there is some kind of strange configuration in webpack, karma or typescript we sometimes add comments to explain why it is there. I think it would be nice if we would have a document where we explain our motivation behind all the configuration options.

I would like to create this document, but right now there is no separation between the boilerplate documentation (for the new module) and the readme for the boilerplate itself.

• create configuration page
• add description for each config file
• link to configuration page from readme

[flut1]

Possible solution for the README.md below. We would strip the wiki link when using generator-seng-module

seng-boilerplate

This README contains boilerplate documentation for your new seng module. For usage instructions of seng-boilerplate, please see our wiki pages.

[VictorGa]

+1

Agree with the solution, all documentation related with instructing, examples and demos should be in other section like wiki or even an external web site

[ThaNarie]

Boilerplate info is now placed at the bottom of the readme (that's stripped of in the generator), but moving it to github wiki pages might be a better option.

Note, before removing the bottom part of the readme, we probably need to update the yeoman generator to make sure it doesn't break at the indexOf being -1 :)