Участие¶

Документация "Апофеозиса" хранится вместе с историей изменений проекта. Любой текст должен быть понятен человеку, который откроет его спустя несколько месяцев.

Чем можно помочь¶

Рабочий процесс¶

1. Определите изменение¶

Один Pull Request должен решать одну связанную задачу. Исправление опечатки, новая механика и перестройка навигации - три разных изменения.

Перед крупной работой проверьте:

• существует ли уже страница на эту тему;
• не обсуждается ли аналогичное изменение;
• какие соседние документы могут потерять актуальность;

2. Создайте ветку¶

Используйте короткое имя, отражающее назначение изменения:

combat-overview
crafting-gdd

3. Внесите изменение¶

Следуйте правилам оформления. Теоретическую информацию добавляйте сразу в подходящую страницу GDD. Шаблон фичи используйте как структуру новой страницы с механикой.

4. Проверьте результат¶

pip install -r requirements.txt
mkdocs serve

Перед отправкой выполните проверку:

mkdocs build --strict
python scripts/check_links.py --base-path /apotheosis-docs/

5. Откройте Pull Request¶

Название должно описывать общее изменение:

Актуализация ДизДока Экономики
V1 Предложение Системы Крафта
ADR Система боя 09.10.2026

Когда изменение готово¶

• Страница находится в правильном разделе навигации.
• Заголовок и первые абзацы объясняют назначение документа.
• Факты отделены от предположений и открытых вопросов.
• Внутренние ссылки ведут на исходные .md-файлы.
• Сборка и проверка ссылок проходят без ошибок.