Define and add better documentation
For now, the prototype's documentation is fairly limited: we have code comments, a couple of usage examples, and that's it. To communicate with others regarding this prototype and how it could evolve towards integration into Gaudi, higher-quality documentation would be desirable.
Three things must be defined before I can proceed with writing such documentation:
- What should be documented? (Headers in the toplevel directory + a couple of necessary details such as identifiers and time representation?)
- How should it be documented? (Tutorial? Full-blown course?)
- In which format? (Is a small LaTeX/asciidoc book okay? Do we need more e.g. doxygen comments?)