You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Thank you!
The text was updated successfully, but these errors were encountered:
You may to add a new doc folder in the root of the project.
Then add two folders inside it: eng and rus.
Each check documentation may be stored in separate *.md file.
You may start with documentation in Russian language and then translate it to English using ChatGPT or another LLM.
You may create a PR for each file.
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: