Man Pages Improvement Sprint: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(more ideas) |
||
| Line 4: | Line 4: | ||
=== Ideas === | === Ideas === | ||
* | * Use Sphinx to generate HTML pages on server (http://trac.osgeo.org/grass/ticket/151) in order to have search engine and nice layout. This requires a conversion to rEST (see ticket). | ||
* Add/cleanup examples | |||
* Add more diagrams where appropriate | |||
* Add idea here | * Add idea here | ||
Revision as of 07:31, 20 January 2011
Markus Metz proposed on [ GRASS-dev ml] to have a "man page improvement day", similar to a code sprint, with the whole community dedicating perhaps a day to finding problems in man pages and fixing them. Benjamin Ducke suggested also to rephrase things that are hard to understand or elaborate on aspects that aren't explained verbosely enough.
Ideas
- Use Sphinx to generate HTML pages on server (http://trac.osgeo.org/grass/ticket/151) in order to have search engine and nice layout. This requires a conversion to rEST (see ticket).
- Add/cleanup examples
- Add more diagrams where appropriate
- Add idea here
Who's interested
- Markus Metz
- Benjamin Ducke
- Dylan Beaudette
- Markus Neteler
- Anne Ghisla
- Martin Landa
- Milena Nowotarska
- Robert Szczepanek