DOCS

Как помочь

Вы окажите неоценимую помощь, если внесете свой вклад в оформление документации.

Таким вкладом может быть:

• Указания на неточности, ошибки, опечатки
• Предложения о редактировании отдельных разделов
• Внесение дополнений

Вы можете сообщить обо всем этом в обсуждениях на github, завести issue или написать об этом в нашей telegram группе.

Note

Отдельное спасибо тем, кто готов предложить помощь делом и помочь в разработке документации, а также переводе ее на другие языки.

Как начать

Для того, чтобы разрабатывать документацию, вам даже не нужно устанавливать весь проект Propan целиком.

Достаточно:

1. Склонировать репозиторий проекта
2. Перейти в директорию docs/
3. Создать виртуальное окружение

   python -m venv venv
   

4. Активировать его

   source venv/bin/activate
   

5. Установить зависимости документации

   pip install -r requirements.txt
   

6. Запустить локальный сервер документации

   mkdocs serve
   

Теперь все изменения в файлах документации будут отражаться на вашей локальной версии сайта. После внесения всех изменений, вы можете оформить PR с ними - и я с радостью его приму!