Man Pages Improvement Sprint

From GRASS-Wiki
Jump to navigation Jump to search

Benjamin Ducke 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).
  • Use DocBook to generate HTML or PDF pages. This requires conversion to XML. Todo: fulltext search for HTML pages.
  • 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
Retrieved from "https://grasswiki.osgeo.org/w/index.php?title=Man_Pages_Improvement_Sprint&oldid=12377"