On Wed, May 21, 2008 at 3:38 PM, Bruno J. M. Melo <[EMAIL PROTECTED]> wrote: > I'll have (full) time on this weekend and I would like to help with the > documentation tasks > and any related stuff.
Well, it turns out that I've got some family health issues this weekend, so I may be in and out more than expected this weekend. The canonical docs live in sphinx: http://trac.turbogears.org/browser/trunk/docs Here's a list of TG2 related documentation tasks. I will try to put all of these into Trac as tickets with a milestone of Milestone: 2.0-preview-1 first thing tomorrow morning. Beyond this list, theres a whole pile of places in the Pylons docs where Ben has indicated that more needs to be written about various subjects, and it would be very helpful for us to have the pylons docs finished because then they will do a release. * Go through the wiki20 and update the code samples to match the new template design. * Update the wiki20 to use DBMechanic to bootstrap data rather than using the setup script. * Go through the genshi introduction, and fill it out a little bit. * Go through the controller introduction and make sure all the code samples work (lots of it was ported from the 1.0 docs with minimal testing). * Update the SQLAlchemy intro doc. Make the links to the SQLAlchemy docs even more prominent. * Improve the validation doc with information about form-encode schemas * Create a second "address book" tutorial with a more complex model, and more complex templates, which use widgets, DBMechanic for setup, etc. * Create some docs for tgrepozewho, or at least make a ReSTified version of the readme doc for inclusion in sphinx. Also we should be able to copy some of the identity docs from 1.0. * Generally go through the TG2 docs and point out any holes in the documentation. * Create screenshots for docs -- ideally every major doc page will have at least one screenshot or photo. * Write a debugging TG2 doc that shows off the interactive web-debugger * Clean up any last restructured text warnings when generating the docs with sphinx. Optionally we can also: * Update the docs CSS and jinja templates to look even more turbogearsish. * Create a paver script which generates a new version of the html docs * Work with paver's cog integration to create some samples of docs which automatically import snipits of code from sample code files. --Mark Ramm --~--~---------~--~----~------------~-------~--~----~ 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?hl=en -~----------~----~----~----~------~----~------~--~---
