Hi:

I'd like to explain why I re-strut the doc in this way:

First, we'd think about why we find its better to list all informations
in one page? because its an easy way to find the need.(an
encyclopaedia way)
It's true, and its helpful if we want to read all of them.

The question is, why we need all information if we only interest in a
specific region of them?

Some docs are more basic, so they may viewed frequently, and some are
not, they shouldn't distract our attention if we don't need it right
now.

Newbies may need tutorial or install instruction, experienced user may
need API or recipes...etc, evil details keep newbies from the monster
and experienced users may distract by the huge area of basis
information.

Another question is, will we still care the links which are not shown
in front page if we could touch those functional docs such as @expose,
@validate API...etc by click the link at the bottom of  the tutorial?

Well, we did have such powerful tool: 'the url link', it gave us the
capability to show the relational docs but not all docs (the wikipedia
way). That's why I encourage people leave comment for relation docs
link and say its very helpful.

At this time, you may found there're too much documents sparse
everywhere, which didn't shown in front page(well, the links are there,
but not explicit <--I think this is the actual problem)

for example:

there are 5 tutorials there (should we list all in front page?)
http://docs.turbogears.org/1.0/TGArticles

more and more receipies (should we list all in front page?)
http://docs.turbogears.org/1.0/SpecificProblems

lot's of modules and the instruction could be used (should we list all
in front page?)
http://docs.turbogears.org/1.0/AlternativeComponents

and a huge potential candidate base
http://docs.turbogears.org/1.0/RoughDocs

You could imagine that if we continue to organize the doc in old
one-stop front page way, the front page will become a big monster (I
think current front page is a mid-monster though :-P).

My thought of ideal front page is contain about 5 links that point most
important links.
and most information could be accessed without scrolling.

As  the re-org from the get-go, some docs (ex: @decorators) are in
develop stage, so I think it's better not to show them on front page.
Many docs are filled and move to where it should be belonged to, how do
you think where the @decorators should be belonged to?


Hope that make sense

--
Fred


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

Reply via email to