Closed jcfreeman2 closed 3 years ago
As described in this morning's talk, Toward Official DUNE DAQ Software Documentation, as well as at https://dune-daq-sw.readthedocs.io/en/latest/editing_package_documentation/, in a couple of weeks when dunedaq-v2.4.1 is released there should be comprehensive documentation about this package available for users. A good first step on this path - timescale O(1 week) - is to do the following:
docs/
README.md
As described in this morning's talk, Toward Official DUNE DAQ Software Documentation, as well as at https://dune-daq-sw.readthedocs.io/en/latest/editing_package_documentation/, in a couple of weeks when dunedaq-v2.4.1 is released there should be comprehensive documentation about this package available for users. A good first step on this path - timescale O(1 week) - is to do the following:
docs/
subdirectory in your repoREADME.md
is in the base of your repo, move it intodocs/
docs/
; the easiest way to do this is described in https://dune-daq-sw.readthedocs.io/en/latest/editing_package_documentation/