Как внести вклад
Мы приветствуем вклад в улучшение документации! Вот как вы можете помочь.
Процесс внесения изменений
- Найдите репозиторий - определите, к какому продукту относится ваше изменение
- Создайте ветку - создайте новую ветку для ваших изменений
- Внесите изменения - отредактируйте файлы в папке
docs/ - Создайте Merge Request - отправьте ваши изменения на рассмотрение
Правила оформления
Заголовки
- Используйте иерархию заголовков
#,##,### - Один заголовок первого уровня на страницу
- Логическая структура подзаголовков
Код
Используйте тройные обратные кавычки для блоков кода:
```javascript
const example = "Указывайте язык для подсветки синтаксиса";
Ссылки
- Используйте относительные ссылки для внутренних страниц
- Проверяйте, что все ссылки работают
Изображения
- Размещайте изображения в папке
docs/assets/ - Используйте описательные имена файлов
- Добавляйте alt-текст
Автоматическая сборка
После принятия вашего Merge Request:
- GitLab CI автоматически запустит сборку документации
- Изменения появятся на сайте в течение нескольких минут
- Уведомление о сборке придет в канал документации
Обратная связь
Если у вас есть вопросы или предложения:
- Создайте issue в репозитории документации
- Обратитесь в канал #documentation в Slack
- Свяжитесь с командой разработки