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.

Sign up for GitHub

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

Jump to bottom

проблема c документацией #52

Open

diskoo opened this issue Feb 4, 2023 · 1 comment

Contributor

diskoo commented Feb 4, 2023

Проблема README.md
Чушь полная, ничего не понятно.

Как повторить:
Шаги и условия для обнаружения проблемы:

Забудьте на секунд.очку, что вы мамин программист или около того.
Попробуйте, чисто по текущей документации, внести вклад в эту "цветущую" базу знаний.
спойлер У вас ничего не выйдет. И не потму, что вы быдло, а потому, что документация сосет (очевидно, ее писал Дуку с Редбо)

Проблема заключается в том, что:

Документация супер скудная
Документация супер по дэбильному написана

Документы, ссылки, данные
Все просто как палка. В репе активность = 1 землекоп (уже умерший с середины лета), а могла быть больше, возможно.

Предполагаемые направления решений
(опционально, но желательно)

Написать нормальную документацию для людей, а не для программистов.

diskoo changed the title ~~проблема c документацие~~ проблема c документацией

Collaborator

redboo commented Feb 7, 2023

@diskoo будем рады предложенным тобой правкам. Тебе ведь удалось разобраться и понять, что не сходилось с описанием в README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment