Документация Rampart
Индекс всей документации проекта и правила её ведения.
Точка входа — README.md; текущий статус и планы — TODO.md.
1. С чего начать
| Документ |
Когда читать |
| deployment.md |
Первый деплой edge-ноды и manager'а |
| configuration.md |
Настройка config.toml, секция [xdp], переменные manager'а |
| runbook.md |
Ежедневная эксплуатация и типовые операции |
2. Эксплуатация (how-to)
3. Справочник (reference)
4. Протоколы
| Документ |
О чём |
| minecraft-java.md |
Minecraft-edge: Paper, PROXY protocol, закрытый backend |
5. Теория и исследования
| Раздел |
О чём |
| kb/ |
База знаний: анатомия атак, уровни защиты, практика (двуязычная) |
| research/ |
Глубокие разборы: архитектура, eBPF, DDoS, Rust-производительность, конкуренты |
kb/ отвечает на вопрос «как это работает и как защищаться», research/ — на вопрос
«какое решение выбрать и почему». Статус проекта не живёт ни там, ни там — только в
TODO.md.
6. Как вести документацию
- Язык.
docs/ — русский. Исключение: docs/kb/, где статьи
двуязычные (## English / ## Русский). Комментарии в коде — английский (TODO §0.8).
- Один документ = одна задача. How-to начинается с цели («что получится в конце»),
содержит копируемые команды и заканчивается проверкой результата.
- Reference синхронизируется с кодом в том же PR. Меняешь поле конфига, флаг CLI
или эндпоинт — правишь
configuration.md / api.md там же. Расхождение = баг.
- Новый документ кладётся в подходящую категорию (2–4) и сразу добавляется в эту
таблицу; если он является точкой входа — ссылка добавляется и в корневой README.
- Не размножай папки. Плоская структура
docs/*.md — норма; подпапка нужна только
для серии документов (kb/, research/).
- Имена файлов — kebab-case,
.md, без дат в имени; дата и версия — внутри документа.
- Никаких битых ссылок. Перед коммитом:
grep -o '](\.\?[^)]*)' docs/*.md и проверь,
что цели существуют.