yukiawano/sscpmodule — pull request #2 by xeraa (2012-06-09 22:59:33+00:00)
Title: Documentation

Hi Yuki,

I tried to improve the documentation a little, hope I didn't make it worse ;-).
A few comments:
* I've removed the ```yml / html pieces - those are only used on http://doc.silverstripe.org so I think there's no point in using them at the moment.
* What do you think about putting the Notice and Installation instruction on the front page (https://github.com/yukiawano/sscpmodule/blob/master/README.md)? At least the Notice shouldn't be burried inside the docs, but should be clearly visible on the front page.
* Please add a License to https://github.com/yukiawano/sscpmodule/blob/master/README.md - BSD I assume?
* In the AudienceTypes section, please describe what this is actually doing. People might guess what it does, but we should make that clear beyond any doubt ;-).
* I've tried to capizalize all instances of Snippet, DefaultSnippet, Block, and BlockHolder so people can more easily recognize them.
* I've changed the order of the points as it's IMHO easier to follow it like that. What do you think?

General obervations:
* Do we actually need a title for BlockHolders? Looks a bit redundant to me or what do we need it for?
* When creating a Block, why can we select the BlockHolder? Aren't we inside a BlockHolder already or is this just a technical workaround for the moment?
* AudienceType should be selectable in a dropdown or something like that, but I assume that is planned for the future?

Cheers,
Philipp