This site is an archive; learn more about 8 years of OpenHatch.

[OH-Dev] [issue896] improve "landing pages" for oh-mainline documentation

shauna bugs at openhatch.org
Wed Nov 6 00:31:26 UTC 2013


New submission from shauna <shaunagm at gmail.com>:

I'd like to improve the landing pages for OH-mainline documentation.  This would 
include:

- The readthedocs index page (http://openhatch.readthedocs.org/en/latest/index.html): Should be more verbose 
(at least full sentences!) and highlight the most common/important part of the 
documentation.  Make sure to include a section on "how to navigate this 
documentation".  Should link to any key non-documentation aspects of OH.

- Make sure the README in oh-mainline main directory 
(https://github.com/openhatch/oh-
mainline/blob/e485c8d98d5b7386ecf436526305e930ac25e4ad/README.rst) and the 
README in the docs directory (https://github.com/openhatch/oh-
mainline/blob/e485c8d98d5b7386ecf436526305e930ac25e4ad/docs/README.rst) are 
intelligible and link to the readthedocs landing page directly. 

For all of the above, make sure all links go where intended.  (For instance 
clicking ":doc:`deployment/installation`" in the /docs/README.rst brings you 
nowhere.)

----------
messages: 3928
nosy: paulproteus, shauna
priority: bug
status: unread
title: improve "landing pages" for oh-mainline documentation

__________________________________________
Roundup issue tracker <bugs at openhatch.org>
<https://openhatch.org/bugs/issue896>
__________________________________________


More information about the Devel mailing list