Compound Thinking

TurboGears Doc Sprint

I’ll be hosting a TurboGeard Documentation Sprint this coming Saturday, January 13th, right before the TurboGears Jam.

Having a book is good for TurboGears, but we couldn’t cover everything in the book, and not everybody wants or can afford dead-tree documentation, so it’s also important that we create great online docs!

Date: Saturday, 13th January 2007
Location: Ann Arbor, MI, United States (remote participation encouraged!)

We’ll discuss our work on the TurboGears Docs mailing list, on IRC channel #turbogears on freenode, and organize our efforts around the tasks listed below.

Things to work on:

• Widgets Documentation
• Updated “Big Picture” Diagram
• Creating Diagrams to go with various doc pages
• Complete migration of pages from the old trac wiki to this wiki
• Updating DocStrings in the TG code
• Workign on automated API Doc generation
• Creating a script to generate flat HTML versions of the Docs for offine use

There will be work for everybody, at every skill level. We need people to copy over the text from the trac wiki and convert it into ReStructured text, and we need people to update the DocStrings in the TurboGears code. If you don’t want to write docs, but feel comfortable hacking up some code, we need help generating API docs, and we need to create flat HTML files so you can browse the docs offline.

So, if you have a few hours and want to help TurboGears have great Documentation, please pitch in and give us a hand. It will make all the difference in the world for somebody just getting started!