[yt-dev] Docs Proposal

[Nathan Goldbaum]

This looks really great Sam.  I'm +1 on switching to this format as is.

On 7/10/12 1:20 PM, Sam Skillman wrote:
> Hi again,
>
> Here is a working prototype of what the structure would look like 
> (page may change as I update my local build):
>
> http://corvette.colorado.edu/~skillman/yt-docs/ 
> <http://corvette.colorado.edu/%7Eskillman/yt-docs/>
>
> Comments would be greatly appreciated.
>
> Sam
>
> On Tue, Jul 10, 2012 at 12:14 PM, Sam Skillman <samskillman at gmail.com 
> <mailto:samskillman at gmail.com>> wrote:
>
>     Hi all,
>     We had a fairly good discussion in the docs hangout about how the
>     structure of the docs might be improved.  What we've come up with
>     is a reorganization of the front page of
>     http://yt-project.org/doc/index.html
>
>     to have the Overview paragraph, followed by a table of contents
>     entitled "User Guide."  This is what the structure would look like:
>
>       * User Guide (See full Table of Contents ? link to full, or
>         toggle full/collapsed to 2? levels)
>           o "Getting Started"
>               + Installing and updating yt
>               + Cookbook
>               + Field List
>               + FAQ
>           o Analyzing Data
>               + Loading Data
>                   # Enzo Data
>               + Using and Manipulating Objects and Fields
>                   # What Types of Fields are there?
>                  #
>
>               + etc
>           o Visualizing Data
>               + etc
>           o Advanced
>           o Getting Involved
>       * Other Versions:
>           o Latest Docs Build
>           o Current Release (2.4)
>           o yt-project.org/docs/2.1 <http://yt-project.org/docs/2.1>
>           o yt-project.org/docs/2.2 <http://yt-project.org/docs/2.2>
>           o yt-project.org/docs/2.3 <http://yt-project.org/docs/2.3>
>           o yt-project.org/docs/2.4 <http://yt-project.org/docs/2.4>
>
>
>     Here's a GDoc with this layout, as well as some responsibilities
>     in pushing out 2.4:
>     https://docs.google.com/document/d/1gwqrzDbsqKz-V1J0HMcaptPcy0ETsmeVkWKzWIISCu0/edit
>
>     Sam, Britton, John Z., Nathan
>
>
>
>
> _______________________________________________
> yt-dev mailing list
> yt-dev at lists.spacepope.org
> http://lists.spacepope.org/listinfo.cgi/yt-dev-spacepope.org


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.spacepope.org/pipermail/yt-dev-spacepope.org/attachments/20120710/6fa08a89/attachment.htm>