[Doc]: Provide documentation

[PawelPlesniak]

Description

There is currently no documentation for the logging toolkit. There should be one in the root of the repository, under the docs/ path, as this is what is used by the DUNE DAQ sw documentation to generate the webpages.

Suggested changes

Have a few levels of documentation - e.g. from the perspective of a user (i.e. a developer using the toolkit) and from the perspective of the next developer (how all the clases fit together). Note - for the latter this does not need to be comprehensive, but e.g. what the stream in LogHandlerConf is and how it is used would be very helpful for the end dev.

Anything else?

No response

[emmuhamm]

See https://dune-daq-sw.readthedocs.io/en/latest/packages/drunc/Process-manager-interface/

basically just how logging is structured

in the md of this repo, be more specific on how it works. eg for users and devs

for my info

• user facing docs go in the docs folder in each repo, which gets made into readthedocs
• the wiki is for developers (generally less org) and more informal
• then the drunc page (the ones that the rses are making) combines both + passes docstrings of the code

[emmuhamm]

Don't forget to document this bit
https://github.com/DUNE-DAQ/daqpytools/pull/37/changes#diff-f0c6d41f55c5a979bfd86a26ceffa6578745f197952a5c25e57492839d57c2d5R131