Как дополнять документацию

Документацию пишут те, кто делает миссии. Если вы разобрались, как что-то настроить, и на это ушло больше десяти минут — запишите, следующий потратит одну.

Как внести правку

Нужен аккаунт на GitHub. Каждая правка проходит проверку и после неё появляется на сайте в течение нескольких минут.

Поправить страницу

1. Внизу страницы нажмите Редактировать страницу — GitHub откроет её исходный файл.
2. Внесите правку.
3. Нажмите Commit changes…, коротко опишите, что поменяли, затем Propose changes и Create pull request.

Добавить страницу

1. Откройте нужную папку в репозитории: справочник — reference/.
2. Нажмите Add file → Create new file.
3. Назовите файл латиницей через дефис — имя станет адресом страницы: reference/kill-zones.md → /reference/kill-zones/.
4. Скопируйте в него шаблон из папки templates/ и заполните.
5. Отправьте pull request, как при правке.

Скриншоты

1. Откройте в репозитории папку public/images/, при необходимости создайте в ней папку раздела.
2. Нажмите Add file → Upload files и загрузите картинку. Имя файла — латиницей.
3. Вставьте её в текст: ![Что на скриншоте](/images/zones/fill-outside.png).

Если не хотите разбираться с GitHub

Напишите в Discord или создайте Issue: что неправильно, чего не хватает, какой вопрос остался. Правку внесут за вас.

Что писать

• Справочник — одна страница на одну вещь, которую настраивает картодел: компонент, сущность, настройка. Образец: Группы и слоты.
• Рецепты — как собрать конкретную типовую вещь целиком: «TvT на две стороны», «спавн волнами».
• Частые ошибки — «сделал так, а оно не работает, потому что…». Сюда идёт всё, о чём спрашивают в Discord больше одного раза.

Правила

1. Русский — основной язык. Английская страница всегда перевод русской и лежит по тому же пути в папке en/. Поменяли русскую — отметьте в описании pull request, что английская отстала.
2. Язык — строгий, но живой. Пишите точно и по делу, как в хорошем техническом руководстве: без сленга, шуток и «короче». Но и без канцелярита: не «данный компонент осуществляет блокировку», а «компонент блокирует». К читателю — на «вы», инструкции — в повелительном наклонении: «поставьте», «включите».
3. Названия атрибутов — как в редакторе. Пишите так, как поле подписано в Workbench, и рядом имя в коде: «Countdown Seconds (m_CountdownSeconds)».
4. Скриншот лучше абзаца. Обводите на скриншоте то, о чём речь.
5. Указывайте версию мода, если поведение появилось или поменялось в конкретной версии.
6. Не уверены — всё равно пишите, но пометьте блоком «Требует проверки». Неполная страница лучше, чем никакой.
7. Объясняйте правки чужого текста. Нашли ошибку — исправьте и напишите в pull request, что и почему поменяли.

Разметка

Страницы пишутся в Markdown. Кроме обычных заголовков, списков и таблиц пригодятся:

Ссылка на другую страницу — адрес от корня сайта со слешем на конце: [Зоны](/reference/zones/).

Выделенные блоки:

:::note
Дополнительная информация.
:::

:::tip
Полезный совет.
:::

:::caution[Требует проверки]
Что именно нужно проверить.
:::

:::danger
То, что может сломать миссию.
:::

Порядок в меню задаётся в начале файла:

---
title: Название
description: Одно предложение о странице
sidebar:
  order: 5
---