I had no idea this group existed before today, and I've been chatting
with ChrisP and Jorge in IRC for a couple months. All of which ties to
my single issue with TG2. Others may have others, but my issue is
simple, and ChrisP mentions it here:

> to raise awareness of the existing docs.  I
> have written comprehensive tutorials for: tgext.admin, RestController,
> CrudRestController, ToscaWidgets, Sprox Tables and Sprox Forms in the
> past few months.  I just think that maybe our docs need better
> organization, and it is obvious we need to advertise the existing
> documentation better.

That is it, right there. I find numerous little issues with the
documentation, and they can be summed up in a way that might be
surprising.

I'm a developer who wants to use TG for a project. I'm not an
SQLAlchemy developer, or user. Neither am I a developer or user for
Genshi, or ToscaWidgets, or Pylons, or whatever else. I'm using TG. As
such, I expect to be able to use TG docs as my primary reference and
learning source.

Right now, that is not possible. The main documentation page (
http://www.turbogears.org/2.0/docs/ ) provides a slew of information,
but very little by way of organization, and virtually nothing to help
me find even a place to look to solve my problems. A good example of
the issues I see is with multiple databases. Configuring your
application to use them is trivially easy when you know how. Until
that point, though, it's an exercise in futility to find the answer in
the docs. I had to spend a few hours digging through the code to see
where DBSession was created, and then modify my code to do the same
thing.

That's just one issue. The documentation is riddled with such issues.

The primary difference is that I've got ideas for how to fix those
issues, and am working to be able to show something by the weekend. TG
has a lot of documentation written. The only bad part is the
organization.

--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---

Reply via email to