Hi, Documentation is a big enough deal that we've got a project going to build a new tool for managing docs:
http://groups.google.com/group/docudo The concept is very similar to a wiki, but Docudo will specifically address the issue of documentation getting out of date with respect to new versions of the project. I just had a sneaky thought about how to start using Docudo somewhat sooner for TurboGears docs, but I'm not going to worry about that just yet. If you'd like to contribute now to the official docs (something that would be much appreciated), the 0.9 site docs live in the newdocs directory on the svn trunk. They're just XHTML kid templates, so they're pretty easy to work with. If you'd like to do something there, I'd be happy to give you commit access to newdocs. As soon as is humanly possible, I would like to eliminate the wiki because wikis do turn into a source of incorrect information awfully quickly. Kevin On 3/13/06, ajones <[EMAIL PROTECTED]> wrote: > > I was thinking of documenting problems that I encounter with turbogears > as I learn it to help pave the way for other people trying it out. The > mailing list seems like an awesome place to fix stuff, but a lot of > these things should be in the wiki before they turn into recurring > questions. > > My question is, how is this best done? I did not see anything in the > wiki regarding how additional documentation should be structured, > handled, whatever. (Aside from the existing structuring and handling > that is) > > The big concern I have is that what I write may go out of date without > people knowing about it. Would it be a good idea to come up with some > kind of prefix to solutions that says something to the affect of: This > is known to apply for versions $foo and $bar, those using later > versions beware of API changes. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Trunk" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/turbogears-trunk -~----------~----~----~----~------~----~------~--~---
