Hi,

I'm teaching Cython in my Sage course yet again, and noticed that
again there are some very confusing aspects of the Cython
documentation organization, which could probably be improved by a few
simple changes.

  1. At http://cython.org/ there is a big link in the middle of the
page labeled "Cython Users Guide" which goes to
http://docs.cython.org/.   However, http://docs.cython.org/ is *not*
the users guide -- it is "Cython’s Documentation".     In fact, the
Users Guide is Chapter 3 of the documentation.

  2. Looking at http://docs.cython.org, we see that Chapter 2 is
"Tutorials".  But then looking down to Chapter 3 we see that it is
"Cython Users Guide".  Of course, that's what one is after having just
clicked a link called "Cython Users Guide".  So we click on "Cython
Users Guide" again.

  3. We arrive at a page that again has "Tutorial" as Chapter 2.   For
some reason this makes me feel even more confused.

Recommend changes:

  1. Change the link on the main page from "Cython Users Guide" to
"Documentation"  or put a direct link into the Users Guide, or have
two links.

  2. At http://docs.cython.org/ rename the "Cython Users Guide" to
"Users Guide", since it is obviously the Cython Users Guide at this
point and "Cython documentation" is in the upper left of the page
everywhere.

  3. Possibly rename the tutorial in chapter 2 of the users guide to
something like "First Steps" or "Basic Tutorial" or something.

William

-- 
William Stein
Professor of Mathematics
University of Washington
http://wstein.org
_______________________________________________
Cython-dev mailing list
Cython-dev@codespeak.net
http://codespeak.net/mailman/listinfo/cython-dev

Reply via email to