Как внести свой вклад в Вики

Эта вики — проект сообщества. Каждый может помочь сделать её лучше, и для этого не обязательно быть программистом. Спасибо, что решили помочь!

Самый простой способ помочь — сообщить нам об ошибке.

Через GitHub Issues: Нажмите на иконку карандаша (Edit this page) в правом верхнем углу любой страницы. Если у вас нет опыта работы с Git, просто создайте Issue (сообщение об ошибке), подробно описав, что и где нужно исправить.
Через Telegram: Напишите о найденной ошибке в топик «Вопросы и предложения» в нашем основном чате.

Если вы знакомы с Git и Markdown, вы можете вносить правки напрямую. Мы будем очень благодарны!

Вот наш основной процесс:

Форкните репозиторий. Создайте свою копию нашего основного репозитория на GitHub.
Внесите изменения. В своей копии (форке) вы можете редактировать существующие файлы или создавать новые. Пожалуйста, придерживайтесь общего стиля и используйте Markdown.
Создайте Pull Request (PR). Когда ваши правки будут готовы, создайте Pull Request в наш основной репозиторий. В описании PR кратко расскажите, что вы изменили.
Ревью и мёрж. Администраторы вики рассмотрят ваш PR. Если всё хорошо, они примут (смержат) ваши изменения, и они появятся на сайте. Мы стараемся соблюдать ритуал R-2 (Бейзчекинг): перед принятием важной фактической информации два человека должны проверить источники.

Этот раздел основан на ваших исходных данных.

Наша вики работает на движке MkDocs с темой Material for MkDocs. Весь контент хранится в виде .md файлов в репозитории на GitHub.

Ключевые технологии и процессы:

Структура и стиль: Весь контент пишется на Markdown. Структура навигации и основные настройки сайта находятся в файле mkdocs.yml.
Автоматическое развертывание (CI/CD): Мы используем GitHub Actions для автоматической сборки и публикации сайта при каждом изменении в основной ветке. Это обеспечивает актуальность информации.
Хостинг: Основной сайт размещается на централизованном сервере, с зеркалами на IPFS и GitHub Pages для обеспечения доступности и децентрализации в будущем.

Шаблоны и гайдлайны:

Pull Requests (PR) и Issues: Пожалуйста, используйте наши шаблоны при создании PR и ишью. Это помогает нам быстрее обрабатывать ваши предложения.
Формат цитирования: При добавлении цитат или ссылок на внешние источники, пожалуйста, придерживайтесь единого формата. (Тут можно будет добавить ссылку на гайд по стилю).

Ваш вклад, даже самый маленький, невероятно важен. Спасибо! 0