Поучаствовать

Предложить изменения

Поучаствовать в развитии документации можно несколькими способами:

1. предлагайте изменения/дополнения в ZEEKR Club в Telegram
2. создавайте темы на Github - OS-Car-Man
3. на интересующей вас странице нажать на иконку "внести изменения" и внести изменения самостоятельно.

Режим разработчика

Mac OS / LinuxWindows

• установить Docker
• сделать форк https://github.com/os-car-man/os-car-man и склонировать его себе
• запустить make build, чтобы собрать образ, необходимый для локальной работы с документацией
• запустить make docs
• открыть http://localhost:7777 в браузере
• внести изменения в код
  • документация пишется на Markdown-е, используя mkdocs-material
  • навигация в mkdocs.yml в корне
  • сама документация в папке docs
• проверить результат в браузере
• отправить изменения на Github и создать Pull request

• установить Docker
• TO BE CHECKED установить make - help link
• сделать форк https://github.com/os-car-man/os-car-man и склонировать его себе
• запустить make build, чтобы собрать образ, необходимый для локальной работы с документацией
• запустить make docs
• внести изменения в код
  • документация пишется на Markdown-е, используя mkdocs-material
  • навигация в mkdocs.yml в корне
  • сама документация в папке docs
• проверить результат в браузере
• отправить изменения на Github и создать Pull request

Добавление плагинов / библиотек

• добавить библиотеку в ci-requirements/requirements-3.11.in
• make build
• make docs