Hi All,
Ingo's been tweeting about the little OSX Docs viewer "Dash" (
http://kapeli.com/dash) a little while ago, and I bought it and was pretty impressed. Basically it allows me to have my PHP/jQuery/Compass/etc. docs available offline, instead of having to google. I can see it as a great benefit, especially for the times when I'm travelling, or on a bad internet connection.
We were joking that it could be nice to have the SilverStripe docs available there, and now Will also showed some interest, so I'm outlining my thoughs on it here:
You can read about the required format for a docset here:
http://kapeli.com/docsets
API:
It seems that could be easily achieved by running a Doxygen instance somehwhere (see #6)
Docs:
See #7. I'm imagining creating this through a static publisher instance on the
ss.org site that creates a static directory of the documentation every night.
We'd also need a task for creating the needed SQLite index - I could see this a good blueprint on how to do that:
https://github.com/silverstripe/silverstripe-docsviewer/blob/master/code/tasks/RebuildLuceneDocsIndex.php
I can't promise I'll have the time to look into this in the near future, but just wanted to present my thoughts on this here, and bounce it off with the community. Does anyone think this is a good idea, and what do you think about the way I'd implement it?
Anselm