-
-
Notifications
You must be signed in to change notification settings - Fork 16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add detailed information for each check #419
Comments
I'd like to work on this issue as I want to understand better how the library works. |
@marijarin it would be great! You may to add a new |
Watch first of all Start with
Additional videos Additional articles |
@marijarin take a look at https://habr.com/ru/articles/871546/ |
@SButterfly |
@mfvanek Thanks for an article with detailed description. I did about a half in Russian, hope to send a PR at the weekend |
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!
The text was updated successfully, but these errors were encountered: