Update repository documentation

[alejandrosame]

Where?

README files.

Who?

Intended audiences are users and contributors.

What?

Before finishing the milestone, we need to update the repository documentation and guidelines reflecting all the changes made.

Additional Context

This task should be worked on after #289, #290, #291, #292, #295 and #296 are finished.

[8bitmp3]

Thanks @alejandrosame

VSCode has some nice linting features: https://code.visualstudio.com/docs/python/linting and https://code.visualstudio.com/docs/python/linting#_pydocstyle

Maybe you can also get GitHub to run checks at every PR via .github/workflows/ci.yaml.

[alejandrosame]

@8bitmp3 Makes absolute sense. We already run style checks through black, but that does not include docstring linting.

Thank you!