Please, add detailed documentation about each check in the README and java docs.
The detailed documentation should include:
What this check is about
What could go wrong if not fix it
It should help quickly onboard new engineers, who are not familiar with the library, but have to fix the failure.
Currently, the detailed documentation is mostly stored in habr.com and in the Russian language. This adds more barriers for English-speaking engineers to dig into the issue and fix it.
Hello
Please, add detailed documentation about each check in the README and java docs.
The detailed documentation should include:
It should help quickly onboard new engineers, who are not familiar with the library, but have to fix the failure. Currently, the detailed documentation is mostly stored in habr.com and in the Russian language. This adds more barriers for English-speaking engineers to dig into the issue and fix it.
Thank you!