On 23 November 2012 13:57, dimitris chloupis <[email protected]> wrote: > Thank you Igor , this was the type of answer I wanted . Ok I think I will > work first on documenting the code and creating a pdf that helps the user > understand how to use Athens. After I gain a very good insight through > documentation of how Athens works I start contributing code. I assume for > documenting code (adding doc strings to methods missing them) files out and > attaching them here will do or you want me to upload to my own project in > ss3 ? > > Well, i was thinking more about format which is available online. And because Athens documentation will absolutely require a lot of illustrations, i think best would be to use HTML for it. (or something which generates html ). Making a PDF out of it is not a big deal, isn't?
Of course, this is not makes class/method comments less important. But i vote for online documentation first. Because most of people don't even understand the basic concepts of paths/contours and coordinate system.. and class comments are not really helpful for that. I wanna have something like Amber documentation: http://amber-lang.net/documentation.html Also, as for the starting point, what things we should describe there, i think OpenVG spec could serve as a guiding source. www.khronos.org/registry/vg/specs/openvg_1_0_1.pdf it contains a lot of material which we can reuse for starters: matrices, coordinate system, paths and path commands etc. So, for getting started we much decide what source format we should use. and where we will host it (as an early-term solution i propose to just create a project on github). And then first step would be to make a TOC :) -- Best regards, Igor Stasenko.
