docs: fixes

This commit is contained in:
Oleg Kalachev
2018-11-21 22:08:27 +03:00
parent 74940a3e31
commit d32ec1004f
2 changed files with 9 additions and 9 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 170 KiB

After

Width:  |  Height:  |  Size: 167 KiB

View File

@@ -4,6 +4,8 @@
Ежедневно несколько сотен человек используют его для обучения и реализации своих проектов.
> **Note** Для внесения предложений по изменению документации или ПО Клевера необходимо иметь аккаунт на [GitHub](https://github.com).
## Markdown
Вся документация Клевера написана в широко распространенном формате [Markdown](https://ru.wikipedia.org/wiki/Markdown). В Интернете существует множество руководств по нему.
@@ -12,21 +14,19 @@
На английском: https://www.markdownguide.org/getting-started, https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet.
> **Note** Для внесения предложений по изменению документации или ПО Клевера необходимо иметь аккаунт на [GitHub](https://github.com).
## Исправление ошибок в документации
Если вы нашли ошибку в документации или хотите ее улучить, используйте механизм Pull Request'ов.
Если вы нашли ошибку в документации или хотите ее улучшить, используйте механизм Pull Request'ов.
* Найдите файл интересующей вас статьи в репозитории  https://github.com/CopterExpress/clever/tree/master/docs,
* Нажмите кнопку "редактировать".
1. Найдите файл с интересующей вас статьей в репозитории  https://github.com/CopterExpress/clever/tree/master/docs.
2. Нажмите кнопку "редактировать".
<img src="assets/github-edit.png" alt="GitHub Edit">
* Внесите необходимые изменения.
* Нажмите кнопку "Propose file change".
* Опишите ваше изменение и нажмите кнопку "Create Pull Request".
* Ожидайте принятия ваших изменений :)
3. Внесите необходимые изменения.
4. Нажмите кнопку "Propose file change".
5. Опишите ваше изменение и нажмите кнопку "Create Pull Request".
6. Ожидайте принятия ваших изменений :)
Более подробную информацию о Pull Request'ах смотрите [на GitHub](https://help.github.com/articles/about-pull-requests/) (англ.) или в [документации по git](https://git-scm.com/book/ru/v2/GitHub-Внесение-собственного-вклада-в-проекты) (русск.).