Skip to content

Add detailed information for each check #419

Open
@SButterfly

Description

@SButterfly

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!

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions