hdf-compass icon indicating copy to clipboard operation
hdf-compass copied to clipboard

Provide User Guide

Open jreadey opened this issue 9 years ago • 3 comments

Provide end-user guide. (via ReadTheDocs?). Link to Help menu item.

jreadey avatar Oct 09 '15 00:10 jreadey

About documentation, I believe that:

  • the content of the 'docs' folder is outdated: https://github.com/HDFGroup/hdf-compass/blob/develop/docs/index.rst
  • the documentation should be unified (with the "Compass model" as a chapter/section). Looking at the conf.py I can read "HDFCompass Data Model". So I would substitute it with a mode generic "HDF Compass"
  • it is missing a make.bat for Windows user (there is only the Makefile: https://github.com/HDFGroup/hdf-compass/blob/develop/docs/Makefile)

giumas avatar Oct 22 '15 18:10 giumas

This is a possible structure for the manual: http://giumas-hdf-compass.readthedocs.org/en/latest/

giumas avatar Oct 22 '15 20:10 giumas

User guide should mention the key-bindings for navigation (#101)

jreadey avatar Oct 27 '15 22:10 jreadey