Now that we have some functional code in libtopotoolbox, we should start documenting it more thoroughly. The goals for the documentation should be
Document the libtopotoolbox API so that users can use libtopotoolbox in their projects
Detail the mechanics of incorporating libtopotoolbox into another project
Describe the build process, CI system, style guidelines and other information that contributors need to know to contribute effectively to libtopotoolbox
Provide enough information about the structure of the code that contributors and future maintainers understand what it is for, how it does what it does, and the design decisions that went into it
[x] #27
[x] #28
[x] #29
[x] #13
[ ] #30
[ ] #64
This issue coordinates the creation of these documents and others that might come up during this initial phase of development, and I intend to close it once we have these documents and the appropriate infrastructure for supporting them. Documentation should continue to be added and improved as development of the library continues.
Now that we have some functional code in libtopotoolbox, we should start documenting it more thoroughly. The goals for the documentation should be
This issue coordinates the creation of these documents and others that might come up during this initial phase of development, and I intend to close it once we have these documents and the appropriate infrastructure for supporting them. Documentation should continue to be added and improved as development of the library continues.