Use Wyam for documentation
pascalberger opened this issue · comments
Don't know if this is possible, but IMHO it would be nice to use Wyam for documentation and publish it to the root of https://cake-contrib.github.io.
In this case we could also maintain some kind of JSON file with information about the addins and generate content of the status.md, addins.md and modules.md file dynamically.
With this https://cake-contrib.github.io could serve as a nice site for browsing the different addins part of this organization.
@pascalberger said...
Don't know if this is possible, but IMHO it would be nice to use Wyam for documentation and publish it to the root of https://cake-contrib.github.io.
Yip, this is possible. We would need to change the name of this repository though to cake-contrib.github.io.
https://help.github.com/articles/user-organization-and-project-pages/#user--organization-pages
Overall, I think that this is a good idea, I am just wary of taking away/duplicating too much that already exists on cakebuild.net. I like the idea of all the addins that are being housed in this organisation being in one place though.
@gep13 I see the point of duplicating stuff on cakebuild.net, but we currently are already doing this with the Wyam sites for individual addins (eg. the API documentation there). But to avoid this, there would need to be a possibility to add addin documentation (contextual pages) to the main cakebuild website and I'm not sure if this would be the better way.
@pascalberger said...
but we currently are already doing this with the Wyam sites for individual addins
Yes, I agree about teh duplication there. My main thought process there is to allow for testing of your own addin documentation, to make sure that it is all working, while waiting for the main cakebuild.net website to be re-published.
And obviously, in addition to the XML comments, the contextual pages that go with it are very useful, so there is definitely a case for them to be created. In general, I am all for doing this work.