Wizzup?
2013-09-28 08:30:41
Hi,
Now that Simba 1.0 is released, it is time to look at the aspects that usually lag behind a bit. One of them is documentation.
For those familiar with the SRL documentation, Simba has an equivalent. Hopefully you've seen it before: http://docs.villavu.com/simba/
We are looking to improve the documentation in several ways. For this, we need your help. The things we would love to see:
Working with the Simba documentation is really quite simple. In the github repository, there is a folder Doc, and in that folder doc, there is a folder caled sphinx. Inside the sphinx folder resides all the Simba documentation. The format is restructured text, just like with SRL 6. There is some more information here: http://docs.villavu.com/simba/docdoc.html
If you want to help, please let us know. Feel free to work on anything, without asking even. And if you get stuck or want to help but don't know how, then please just post here. We'll try to help you as soon as possible.
Cheers,
Wizzup
Now that Simba 1.0 is released, it is time to look at the aspects that usually lag behind a bit. One of them is documentation.
For those familiar with the SRL documentation, Simba has an equivalent. Hopefully you've seen it before: http://docs.villavu.com/simba/
We are looking to improve the documentation in several ways. For this, we need your help. The things we would love to see:
- Improvements to the ``Getting Started'' page: http://docs.villavu.com/simba/gettingstarted.html
- (Any) contents in the Tutorial: http://docs.villavu.com/simba/tutorial.html
- Documenting undocumented functions
- Adding examples for functions
- Synchronising the sections in the Simba documentation and Simba function list (double clicking on an internal function will bring up the documentation page, but if the sections are different you will just see a 404).
- Improving the documentation page on documentation (no, really!): http://docs.villavu.com/simba/docdoc.html
- … And more
Working with the Simba documentation is really quite simple. In the github repository, there is a folder Doc, and in that folder doc, there is a folder caled sphinx. Inside the sphinx folder resides all the Simba documentation. The format is restructured text, just like with SRL 6. There is some more information here: http://docs.villavu.com/simba/docdoc.html
If you want to help, please let us know. Feel free to work on anything, without asking even. And if you get stuck or want to help but don't know how, then please just post here. We'll try to help you as soon as possible.
Cheers,
Wizzup