Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Next steps on minidaqapp documentation #10

Open
jcfreeman2 opened this issue Apr 27, 2021 · 0 comments
Open

Next steps on minidaqapp documentation #10

jcfreeman2 opened this issue Apr 27, 2021 · 0 comments

Comments

@jcfreeman2
Copy link
Contributor

Currently, the README.md + Wiki pages contain the following:

  • https://dune-daq-sw.readthedocs.io/en/latest/packages/minidaqapp/ : this contains a link to minidaqapp diagrams, which are pretty helpful (and also up-to-date?), a link to each repo of the packages minidaqapp depends on (which seems more developer- rather than user-focused) and then links to the rest of the documentation
  • https://dune-daq-sw.readthedocs.io/en/latest/packages/minidaqapp/Simple-instructions-for-running-the-app/: it seems like "Quick-start instructions" and "Preparing to run the application for the first time" state basically the same thing, though perhaps the point is moot because they're focused on minidaqapp developers and thus removable. The "Changing the trigger rate dynamically" looks useful. The "Steps to enable and view ERS and TRACE debug messages" contains material which (should) be covered in our logging documentation.
  • All other pages: clearly are developer-focused, and thus should be cut from the official documentation.

As far as additions: it might be nice to come up with a prose version of Carlos's talk from last month https://indico.fnal.gov/event/47549/contributions/211741/attachments/141630/178791/Minidaq_app_Tutorial_v2.4.0.pdf, at least taking the parts that don't overlap with the existing documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant