DUNE-DAQ / DUNE-DAQ/cmdlib

Documentation improvements

Open
#31 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
0
Forks
1
Avg merge
1m
Merged PRs (30d)
1

Description

The cmdlib documentation hasn't been touched in years. In the current state of the documentation, it's unclear where cmdlib fits into the broader context of DUNE DAQ, particularly the v5/drunc world. I would appreciate an expert review of the documentation. The current examples and code snippets should be checked to see if they're outdated. Also, the docs should provide more context on commands and commanded objects for non experts, beyond the fact that they're json files. Where and how are they used? Who would need to write one?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the current cmdlib documentation, examples, and code snippets, then compare their context with the DUNE DAQ v5/drunc world. Done means the documentation explains commands and commanded objects, their usage and intended authors, and identifies or updates outdated material.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.