[gambit-list] Adding docs to wiki?

Marc Feeley feeley at iro.umontreal.ca
Sun Nov 30 08:32:31 EST 2008

Having the documentation on the wiki or some user editable place would  
be useful.  However, I think the documentation should be written in  
one "universal" markup language so that all forms of the documentation  
can be generated from it (.pdf, .html, .info, and "wiki" editable).   
Currently that markup language is texinfo.  Moreover, eventually I  
would like the documentation for the procedures and special forms to  
be inside the source code and the examples in the documentation should  
be tested for consistency when the regression tests are run.  I'm  
unsure how all of this can work.  Is there a documentation maintenance  
system that supports all of this?  Otherwise can one be built?


On 29-Nov-08, at 8:24 AM, Ali wrote:

> Hi there, I'm new to Gambit and it looks like an excellent bit of  
> software.
> I was wondering whether or not it would be a good idea to copy the  
> docs onto the wiki system.
> I'd be more than happy to copy the text across and wiki format it if  
> desired.
> As I see it this would have the usual benefits of a wiki,
> but the disadvantage of having 2 copies of the docs which need to be  
> synchronised.
> What do you think? Would such a move bring more disadvantages than  
> advantages?
> Ali
> _______________________________________________
> Gambit-list mailing list
> Gambit-list at iro.umontreal.ca
> https://webmail.iro.umontreal.ca/mailman/listinfo/gambit-list

More information about the Gambit-list mailing list