Hello, thanks Diego for the feedback! Some comments inline:
On Fri, 8 Sep 2006, Diego Betancor wrote: > 1. Answer all questions. Few days ago I asked about a registrar (did read > the doxygen generated documentation, read the mailing list) nobode > answered. It didn't make me feel welcome. Yes, I agree this is something very important. We should try to respond to all queries. Btw, I guess in this case your mail was responded to in the end, but nevertheless, there have been other mails on this list that never got an answer, so we could do better. > 2. Document the API in one place with examples. Not just put there the > doxygen, because from it is not clear at all how to use. List main > functions, list main tags in a point. Not only nua, but nta, su, soa . Lots > of little examples. It can be in the wiki. Yeps, this has been raised by others as well. Big thanks go to Nickolay for starting the tutorial page at our wiki. I do hope that the growing supply of example/reference code will aid somewhat in the areas where our documentation is currently lacking. Also I think we should continue improving our doxygen documentation (especially to make it more easy to navigate). The doxygen docs have the big advantage that they are linked 1:1 to our version control system. > 3. FAQ. Very important. How do I do this or that?. Why would I use nta and > not nua?, what is the diference in taking care of dialog, ACKs, timers?. > Could I use nua and nta at the same time?. How do I differenciate dialogs > from diferent clients?, etc. A good idea, let's start right away: http://wiki.opensource.nokia.com/projects/Sofia-SIP_FAQ > 5. How to help. Another good one. First, I think we need help in getting our "how to help" page in shape. :) I put a start at: http://wiki.opensource.nokia.com/projects/SofiaHowToHelp I had more text already, but Firefox crashed (ugh, this was a first time for me with wikis -- I should know better), when I hit save. Feel free to improve and add things to the list. > 6. Have all the documentation in a downloable tarball (or zip), so it can > be read and studied locally. Hmm, a good idea as well -- the doxygen stuff can be generated locally (and for instance on debian you can get it with 'apt-get install sofia-sip-doc'), we should probably advertize this option better. -- under work: Sofia-SIP at http://sofia-sip.sf.net ------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 _______________________________________________ Sofia-sip-devel mailing list Sofia-sip-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/sofia-sip-devel
