On Tue, Jun 30, 2009 at 3:56 PM, Michael Pedersen <[email protected]> wrote:
> The API guide is something I'm heading towards, though I think that will > among the last pieces to come together from me, honestly. > > Got a bunch of work ahead of me before I can consider that. For instance, > next is building up the todo listing. Considering that I have around 800K of > text to read before I complete that task, I'm not sure how quickly I'm going > to be working on an API guide. > In case you hadn't seen it, Sphinx has a "todolist" extetnsion which combines your todos scattered throughout the text into a single list. I use it all the time for my own projects, though I usually take it out once my docs are "finished". > > And after that TODO list, the first bits of new documentation are going to > be me focusing on the overall architecture, showing what components are > installed, what they do, etc. There's a lot of work to be done before the > docs reach the point where I will feel they are truly excellent. > I've been thinking that a "lifecycle of a TurboGears project" would be helpful. Sort of an overview of the quickstart/code/test/package/deploy cycle. > > So, if you want to pitch in, by all means, please do! I gave the url for my > bitbucket repository. Fork it, update your fork, and send me pull requests. > I'll take them, definitely. > > Michael J. Pedersen > My IM IDs: Jabber/[email protected], ICQ/103345809, > AIM/pedermj022171 > Yahoo/pedermj2002, MSN/[email protected] > > > > On Tue, Jun 30, 2009 at 4:20 PM, Derick Eisenhardt < > [email protected]> wrote: > >> >> Another feature the docs desperately need (if they're already there, I >> haven't been able to find it other than searching for a specific >> module) is a clean and easy to navigate API guide...preferably >> something similar to what Dojo has here: http://api.dojotoolkit.org >> > This should be "just" a matter of organization, unless I'm not understanding what you're looking for. > >> Also, I'd rename the "Up and Running" headline to simply "Getting >> Started" as I think that's both clearer and simpler for new users. >> >> And, I'd just like to say thank you Michael, I was planning to start >> something similar myself soon, but now maybe we can simply work >> together ;) >> >> - Derick >> >> > > > > --~--~---------~--~----~------------~-------~--~----~ 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 -~----------~----~----~----~------~----~------~--~---
