> Although the devs are really putting a lot of effort into the > documentation, there's a fundamental problem. Let me try to describe > it. > > ... > > Because of the wide range of interchangeable pieces in TG2. It all > needs to be covered in documentation, and it is, most of the time. > But the problem I often find is the lack of _depth_ in the > documentation. The examples look elegant and easy, they work, those > were the code snippets that made me enthusiastic about TG. > But just when you want to build a reald world application, you need > something a bit more powerful and all you're left with is the TG > source. That's the feeling I get sometimes. I've got no idea if > anybody feels the same way.
I think everyone on the TG team would like to get more feedback as to _where_ the depth is needed. We currently have 2 people who have really dedicated themselves to documenting TG2 (thanks to them!) and they are very open to suggestions. We are also planning a doc sprint as soon as the docs get to a place where they are organized enough for such an activity. I personally think the problem is not depth, but organization of the docs, because I frequently am told there is nothing on a subject, only to provide a person a link to more in-depth information. For instance, in this case you needed more information about Sprox, not CRC, and there is a more in-depth tutorial at: http://www.sprox.org/tutorials/table.html Sprox also has module-level documentation, so there should be enough information there to get what you need out of it. The challenge with tutorials is that to make a good tutorial you need to focus on one particular topic, and gloss over others. I have been doing my best to write tutorials for all of the code I write and use every day, but most tutorials take between 8 and 12 hours to write, and this work is done in addition to my regular day job(s). In short, TG needs help in this area. Many of the tickets here: http://trac.turbogears.org/query?status=new&status=assigned&status=reopened&milestone=2.1 are documentation related. Also, you might drop into the trunk dev list and check out posts like this one: http://groups.google.com/group/turbogears-trunk/browse_thread/thread/4b40c38088761123 Finally, I provide a reasonable amount of _FREE_ live tech support on the irc channel (#turbogears @ irc.freenode.net) So feel free to drop in and ask some questions. If I can't answer them, there are usually a few people in there who can either tell you the answer, or find someone for you that can. cheers. -chris --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears" 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?hl=en -~----------~----~----~----~------~----~------~--~---
