documentation

[ebreitmo]

Re the documentation for https://github.com/EVERSE-ResearchSoftware/QualityPipelines/tree/main:

1. I think it is missleading that the first sentence of the documentation states that it is a command-line tool. As I understand it, it can be used both as CLI or Github action, and new potential users might not read further if they don't find anything about github actions here.
2. At the very beginning it is also stated that it comes with a 'bunch of pluggins'. It might be nice to mention the option to extend the pool of existing pluggins (for anyone who wants to), possibly link to the section lower down with more technical details?

[tamasgal]

Thanks @ebreitmo you are of course right. I am currently working on a more structured documentation, please have a look her: #59

We will also reiterate on the README and probably delete a few things and refer to the then deployed docs sections.

[ebreitmo]

Excellent. Happy to write/edit some stuff if needed - just let me know when you are ready.

[tamasgal]

If you like, comment there and we can merge, then we continue to improve further :) After merging, the deployment should happen automatically, so it's maybe easier to see how it looks like. Currently you have to check out that branch and run make docs followed by make docs-server if you want to have look on your computer

[dgarijo]

Awesome, I think I may add a table for tools and their supported indicators.