On Aug 28, 2006, at 1:37 PM, Karl Guertin wrote: > > On 8/28/06, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote: >> Users are distributed from different spot of TG learning curve, we >> need >> document to help getting their work done. But we don't welcome the >> redundant infomation to distract us. >> In case list all docs in first page is not very efficient for a >> glance. >> The huge list scare newbies and it takes longer to find what we need. > > This is a difference in philosophy. I personally prefer a single page > for docs that is broken up into coherent sections. This allows in-page > searching for what you're looking for and provides a consistent place > to go to answer all your questions (and thus faster than having to > check several places).
Yes. Unless there is an overwhelming quantity of documentation, a one page index is preferrable. > I've chosen to group the documents by level of detail because a number > of documents are cross-cutting and don't neatly fit into "model", > "view", and "controller" categories. Don't forget that a link can reasonably appear in two places :) >> "SQLObject", "SQLAlchemy" section within "design model" links, and so > > I know that Kevin really would prefer that the official docs deal with > using the official components. I've created the apocrypha section > because people _will_ use other components and I'd like to provide > instructions on how to do so while making it clear that they aren't > the official way to do things. I plan on giving docs in this section > either :status: Apocryphal or :status: Officially Unofficial. I think it's fine for SQLAlchemy docs to appear as "Official", but there should be much less emphasis and an explanation of SQLAlchemy's status in the framework right now. I've written about that a couple of times on the list and for the book (and I could write that paragraph again, if desired :). Kevin --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Docs" 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-docs -~----------~----~----~----~------~----~------~--~---
