In regards of recent discussions we want to clean up IPPL's documentation:
We currently have the “new IPPL manual” hosted in a separate repo IPPL-framework/Manual and it is availlabe at https://ippl-framework.github.io/Manual/.
But it is not mentioned or linked in the README.md or in the GitHub about, this should be ammended:
We still have the entire ippl 1.0 manual in the repo, which is outdated:
We have some "manual-like" pages added to the doxygen documentation, which are partially outdated. We decided to keep the pure doxygen created documentation. But we further need to ...
We also have a bunch of additional markdown files:
- ippl/INSTALLATION.md
- ippl/WORKFLOW.md
- ippl/UNIT_TESTS.md
With the new manual I am not sure if any or all of these are necessary to stay alive as a file in the main repo, so we should discuss if we want to either...
1. ... keep them as is.
2. ... move their content exclusively to the manual
3. ... move them to a separate ippl/readme folder and link to them from the main ippl/README.md file.
The main README.md has large section on SLURM Job scripts and Profiling. I think we should try to keep the main README.md as neat as possible, and give these sections the same treatement as the previously mentioned separate markdown files.
So again either...
1. ... have separate md files for these in ippl/ or ippl/readme/ and link to them from the main README.md (if they are essential enough to be in the main repo).
2. ... move them to the new manual.
In regards of recent discussions we want to clean up IPPL's documentation:
We currently have the “new IPPL manual” hosted in a separate repo IPPL-framework/Manual and it is availlabe at https://ippl-framework.github.io/Manual/.
But it is not mentioned or linked in the README.md or in the GitHub about, this should be ammended:
We still have the entire ippl 1.0 manual in the repo, which is outdated:
We have some "manual-like" pages added to the doxygen documentation, which are partially outdated. We decided to keep the pure doxygen created documentation. But we further need to ...
We also have a bunch of additional markdown files:
With the new manual I am not sure if any or all of these are necessary to stay alive as a file in the main repo, so we should discuss if we want to either...
1. ... keep them as is.2. ... move their content exclusively to the manual
3. ... move them to a separate ippl/readme folder and link to them from the main ippl/README.md file.The main README.md has large section on SLURM Job scripts and Profiling. I think we should try to keep the main README.md as neat as possible, and give these sections the same treatement as the previously mentioned separate markdown files.
So again either...
1. ... have separate md files for these in ippl/ or ippl/readme/ and link to them from the main README.md (if they are essential enough to be in the main repo).2. ... move them to the new manual.