Skip to content
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

Open
SButterfly opened this issue Jun 15, 2024 · 3 comments
Open

Add detailed information for each check #419

SButterfly opened this issue Jun 15, 2024 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@SButterfly
Copy link
Contributor

Hello

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!

@mfvanek mfvanek added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jun 15, 2024
@marijarin
Copy link

marijarin commented Oct 17, 2024

I'd like to work on this issue as I want to understand better how the library works.

@mfvanek mfvanek removed the help wanted Extra attention is needed label Oct 17, 2024
@mfvanek
Copy link
Owner

mfvanek commented Oct 17, 2024

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 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants