[ET Trac] [Einstein Toolkit] #218: Documentation page should be better organised

Einstein Toolkit trac-noreply at einsteintoolkit.org
Thu Jan 20 10:52:20 CST 2011


#218: Documentation page should be better organised
----------------------------+-----------------------------------------------
 Reporter:  hinder          |       Owner:     
     Type:  defect          |      Status:  new
 Priority:  major           |   Milestone:     
Component:  Cactus website  |     Version:     
 Keywords:  documentation   |  
----------------------------+-----------------------------------------------
 The documentation page of the Cactus website,

   http://cactuscode.org/documentation/

 currently consists of a main body of text and a sidebar on the right.  The
 main body contains links to the PDF versions of some of the documentation,
 and the sidebar contains links to other pieces of documentation, some but
 not all of which are in the main body as well.

 I propose that the sidebar is redundant, and not going to be noticed by
 most people as it is a sidebar, and should be removed.  The documentation
 that is linked to from the sidebar should be linked to from the main part
 of the page, and the links should be to the HTML versions of the
 documentation.  We could also provide links to the PDF versions as well,
 if anyone likes them.

 We could also be more descriptive about what each piece of documentation
 is.  For example, indicating which document new users should start with
 (User's Guide).

-- 
Ticket URL: <https://trac.einsteintoolkit.org/ticket/218>
Einstein Toolkit <http://einsteintoolkit.org>
The Einstein Toolkit


More information about the Trac mailing list