Как дополнять документацию
Документацию пишут те, кто делает миссии. Если вы разобрались, как что-то настроить, и на это ушло больше десяти минут — запишите, следующий потратит одну.
Как внести правку
Заголовок раздела «Как внести правку»Нужен аккаунт на GitHub. Каждая правка проходит проверку и после неё появляется на сайте в течение нескольких минут.
Поправить страницу
Заголовок раздела «Поправить страницу»- Внизу страницы нажмите Редактировать страницу — GitHub откроет её исходный файл.
- Внесите правку.
- Нажмите Commit changes…, коротко опишите, что поменяли, затем Propose changes и Create pull request.
Добавить страницу
Заголовок раздела «Добавить страницу»- Откройте нужную папку в репозитории: справочник —
reference/. - Нажмите Add file → Create new file.
- Назовите файл латиницей через дефис — имя станет адресом страницы:
reference/kill-zones.md→/reference/kill-zones/. - Для страницы справочника скопируйте в него шаблон и заполните.
- Отправьте pull request, как при правке.
Скриншоты
Заголовок раздела «Скриншоты»- Откройте в репозитории папку
src/assets/. - Нажмите Add file → Upload files и загрузите картинку. Имя файла — латиницей и по смыслу, например
freezezone_settings.png. - Вставьте её в текст путём от страницы:
- со страницы справочника (
reference/…) —; - с остальных страниц —
.
- со страницы справочника (
Страницы в en/ лежат на уровень глубже, поэтому им нужен на один ../ больше.
При сборке картинка сжимается сама, а на сайте по щелчку открывается в полном размере.
Если не хотите разбираться с GitHub
Заголовок раздела «Если не хотите разбираться с GitHub»Напишите в Discord или создайте Issue: что неправильно, чего не хватает, какой вопрос остался. Правку внесут за вас.
Что писать
Заголовок раздела «Что писать»- Справочник — одна страница на одну вещь, которую настраивает картодел: компонент, сущность, настройка. Образец: Группы и слоты.
- Частые ошибки — «сделал так, а оно не работает, потому что…». Сюда идёт всё, о чём спрашивают в Discord больше одного раза.
Правила
Заголовок раздела «Правила»- Основной язык — русский. Английская страница — перевод русской, по тому же пути в папке
en/. Поправили русскую — английскую можно не трогать: на ней сама появится плашка «перевод может быть устаревшим», аnpm run i18nпокажет все отставшие страницы. - Пишите просто и по делу — как в хорошем техническом руководстве. Без сленга и шуток, но и без канцелярита: не «данный компонент осуществляет блокировку», а «компонент блокирует». К читателю обращайтесь на «вы», в инструкциях используйте повелительное наклонение: «поставьте», «включите».
- Поля называйте так же, как редактор, и добавляйте рядом имя из кода: «Countdown Seconds (
m_CountdownSeconds)». По такой подписи читатель найдёт поле в Workbench, а не будет гадать, что вы перевели. - Показывайте, а не пересказывайте. Скриншот, на котором обведено нужное поле, заменяет абзац описания.
- Называйте версию мода, если поведение появилось или изменилось в конкретной версии.
- Не уверены — пишите всё равно, но поставьте блок «Требует проверки». Неполная страница полезнее пустого места.
- Объясняйте правки чужого текста. Нашли ошибку — исправьте и напишите в pull request, что и почему изменили.
Разметка
Заголовок раздела «Разметка»Страницы пишутся в Markdown. Кроме обычных заголовков, списков и таблиц пригодятся:
Ссылка на другую страницу — адрес от корня сайта со слешем на конце: [Зоны](/reference/zones/).
Путь к префабу или конфигу — ссылкой, которая открывает файл в Workbench: ~EchoLobby для файлов мода, ~ArmaReforger для ванильных:
[`Prefabs/Zones/EH_Polyline_KillZone.et`](enfusion://ResourceManager/~EchoLobby:Prefabs/Zones/EH_Polyline_KillZone.et)Выделенные блоки:
:::noteДополнительная информация.:::
:::tipПолезный совет.:::
:::caution[Требует проверки]Что именно нужно проверить.:::
:::dangerТо, что может сломать миссию.:::Порядок в меню задаётся в начале файла:
---title: Названиеdescription: Одно предложение о страницеsidebar: order: 5---