[yt-dev] Docs Proposal

Sam Skillman samskillman at gmail.com
Tue Jul 10 11:14:38 PDT 2012


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)
      - “Getting Started”
         - Installing and updating yt
         - Cookbook
         - Field List
         - FAQ
      - Analyzing Data
         - Loading Data
            - Enzo Data
         - Using and Manipulating Objects and Fields
            - What Types of Fields are there?
            -
         - etc
      - Visualizing Data
         - etc
      - Advanced
      - Getting Involved
   - Other Versions:
      - Latest Docs Build
      - Current Release (2.4)
      - yt-project.org/docs/2.1
      - yt-project.org/docs/2.2
      - yt-project.org/docs/2.3
      - 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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.spacepope.org/pipermail/yt-dev-spacepope.org/attachments/20120710/74ff31b4/attachment.htm>


More information about the yt-dev mailing list