Moving docs in-repo

At present there is a split in our documentation between several places; 
testtwf-website is supposed to be the authoritative source, but actually 
it's not that well maintained. I suspect this is at least partially 
because of the high overhead for contributing; in order to update the 
documentation for e.g. testharness.js, or the in-browser runner, to 
reflect a code change you would have to make a second PR in the 
testtwf-website repo and wait for another round of review. In practice 
this hasn't been happening, so we need to make things easier.

I suggest we try to move the documentation as close to the code as 
possible (i.e. in the same repo) and make the website generating code do 
the work of pulling in the right files. An obvious way to structure this 
would be to add the projects requiring documentation as submodules of 
testtwf-website.

Received on Wednesday, 23 April 2014 11:49:48 UTC