Styleguide updates and improvements

[trykickoff]

Styleguide updates and improvements

[ashleynolan]

I like the idea of code snippets, but think they should only be included if it can be easily maintained.

Could be something we play around with with the next round of improvements though for sure.

[mrmartineau]

perhaps the styleguide resides in its own repo then is integrated into the generator. That means the base framework is much more simple...

[ashleynolan]

I do think there should be a styleguide in Kickoff’s base, as it is an important part of any project, and so remving it seems counter-intuitive for those not using the generator.

Maybe we need to just sketch out the workflow of this to work out how it best sits and can be maintained alongside the rest of the framework?

[mrmartineau]

Should it be based on Statix? I think it will make it much easier to maintain but will probably be harder for most users to use as its not a simple html file anymore.. Opinions? / @nicbell @munkychop

[mrmartineau]

More examples can be found at http://styleguides.io/examples.html

[ashleynolan]

I think it should be whatever we think is easier to get to grips with and maintain.

Maintenance is the number 1 issue with a style guide, above anything else. I think it probably does make sense to use Statix, simply as it may then mean that there is much less overhead needed if it can be set up in the right way.