On 02/05/2006, at 14:08, Michele Cella wrote:

>
> Hi guys,
>
> I would like to hear your opionion regarding how our docs are actually
> organized, personally I find the *big* index of content too much book
> oriented, it doesn't fit so well inside the web and it's quite
> intimadatory for the newbie, that was my first impression at least.
>
> What I find way more friendly and appealing is the concept of task
> based documentation, for example instead of presenting a link like
> "tg-admin" we should use something like:
>
> "Managing your application from the command line"
>
> or identity:
>
> "Adding authentication support to your application"
>
> and so on.
>
> I'm sure you get the point, I really dislike the index of content
> style, it's pretty difficult to search what you're looking for when
> what you want is searching for the way you have to do a particular
> thing.
>
> Opinions?

+1, though  "reference" style docs are also helpful... maybe these  
could be placed in docstrings and link to the pydoc generated pages  
from the tasks?

Alberto

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

Reply via email to