I've done another wiki reorganization. This reflects my thinking on how the wiki docs are written. In the interest of preventing further index changes, I'm posting it here for comments before I actually make the changes.
http://docs.turbogears.org/1.0/RoughDocs/WikiOrganization The goals of this reorganization are: 1. Get everything on the index page. I believe every document is on this index, even if it is in the reorg section. 2. Get rid of GettingStarted. This is already done. The docs in GettingStarted didn't really know what they wanted to be. Were they tutorials? Recipes? Basic Reference? In any event, people were finding them rather than the pages that would answer their questions. Those that provided information not found elsewhere were migrated to the appropriate bin, those that provided a subset of a Reference topic were removed. 3. Community first. I feel it should be. 4. Clearly organized bins. We now have Tutorials, Cookbook, and Reference with ancillary Community [who] and Hacking TurboGears section which cover the standard topics for those sections. Hopefully everybody has a fairly good idea of what articles go in what bin. - Tutorials are step by step instructions that are meant to get you familiar with a component. [how] - Recipes are instructions for how to solve a specific problem in your project. [what] - Reference are in-depth guides that explain the reasoning behind why something was designed a particular way or how it's used. [why] - API docs (to come) answer what methods are available and what their contract is. [where] There is some overlap (specifically the Internationalization article, it probably should be under Recipes), but there are far fewer overlaps than other organization schemes we've done and I feel these categories are used fairly widely within the Python community so people are more likely to recognize the type of documents in each section. Tutorials and Recipes are divided into sections. These have far less though behind them and are definitely up for suggestion. I have a redesigned CSS file that will make the third level headings indent with the list so the sections have a more distinct visual hiearchy among other fun features. I plan on getting diagrams and whatnot into the reference section and leaving notes near the entry points so those so inclined can find them when they're learning the framework. I do have a list of docs that need to happen before the 1.0 docs are finished and further plans on top of that, but I think that everything fits in this framework. --~--~---------~--~----~------------~-------~--~----~ 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?hl=en -~----------~----~----~----~------~----~------~--~---
