[Mitgcm-support] RE: New documentation layout

mitgcm-support at dev.mitgcm.org mitgcm-support at dev.mitgcm.org
Wed Jul 9 15:45:26 EDT 2003


Hi Sonya,

 Thanks for the comments. We can change some of the headings etc...
The layout was modified because lots of people complained
they couldn't see much except the big buttons, so we tried to make
that bit compact - but I guess we went too far. It could be hard to 
get the full chapter headings down the side though.
 How about we try
 Installation -> "Getting Started"
 Documentation, brings up table of contents
 Quick Links, include all the chapters and titles?
 Access on-line documentation jumps to to table of contents.

 Would that be better? Everyone else - what do you think?

Chris 
-----Original Message-----
From: sonya at whoi.edu [mailto:sonya at whoi.edu]On Behalf Of Sonya Legg
Sent: Monday, December 02, 2002 3:44 PM
To: support at mitgcm.org
Subject: New documentation layout


I've just tried to use the new layout of the documentation 
webpages for the first time. They are a lot less easy to 
find your way around than the old pages, principally because 
the menu bar on the left has so little information. 
The old menu bar had the chapters listed in numerical order. 
The new one has headings that do not correspond to chapters -
e.g. "about" which is the frontpage, "Installation" which 
is most of chapter 3 (but chapter 3's title, 
"Getting started and using the MITgcm" is much more illustrative), 
"tutorials" which seems to be just chapter 3.8 and "documentation" 
which consists of the rest. Why not have the menu correspond to 
the chapter headings as before?

When you click on "access online-documentation" on the frontpage 
you end up straight in chapter 1, 
whereas in the old format you landed on a contents 
page, with helpful descriptions of each chapter. This is very 
helpful for someone who doesn't remember where to start...

Sonya




More information about the MITgcm-support mailing list