JCF: move the README.md to its standard location for DUNE DAQ repos#11
Merged
jcfreeman2 merged 1 commit intodevelopfrom Feb 25, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The standard location for a DUNE DAQ package's
README.mdis in thedocs/subdirectory, rather than the base of the repo; among other things this will allow it to be picked up when documentation is generated byreadthedocs- in fact, there is a old, generatedREADME.mdwhich is already picked up - https://dune-daq-sw.readthedocs.io/en/latest/packages/cibmodules/).This PR gets rid of the old, generated
README.mdindocs/and move the recently-writtenREADME.mdfrom the base of the repo intodocs/.Type of change
Testing here is N/A - moving a
README.mdwon't affect unit tests, etc.Testing checklist
dbt-build --unittest)pytest -s minimal_system_quick_test.py)dunedaq_integtest_bundle.sh)python -m pytest)pre-commit run --all-files)Comments here on the testing
Further checks
dbt-build --lint, and/or see https://dune-daq-sw.readthedocs.io/en/latest/packages/styleguide/)(Indicate issue here: # (issue))