- Split TODO into a thin status index plus docs/roadmap/ with one file per task (v0.4 reliability, v0.5 product, v0.6 research, icebox). - Add docs/architecture.md (current processes, packet/data path, layers, storage, metrics) and docs/development.md (rules, gates, DoD). - Add CHANGELOG.md reconstructed from history; move round details out of TODO. - Align docs with the code: config defaults and missing [detect]/ [protocol.http] sections, XDP metric names, ClickHouse table and TTL, Redis RDB restore, multiarch clang include, CLI binary name. - Add scripts/check_docs_links.sh and run it in CI. - release profile: thin LTO + one codegen unit. Binary 12.3 MB -> 9.7 MB, http parser bench 314 ns -> 278 ns; panic=abort stays off for catch_unwind in the Redis subscriber. - Drop the unused JWT role claim; fix 'rampart doctor' hints in the CLI. |
||
|---|---|---|
| .. | ||
| kb | ||
| research | ||
| roadmap | ||
| api.md | ||
| architecture.md | ||
| configuration.md | ||
| deployment.md | ||
| development.md | ||
| disaster_recovery.md | ||
| minecraft-java.md | ||
| README.md | ||
| runbook.md | ||
| testing.md | ||
| troubleshooting.md | ||
| vds_compatibility.md | ||
Документация Rampart
Индекс всей документации проекта и правила её ведения. Точка входа — README.md; текущий статус — TODO.md; история — CHANGELOG.md.
1. С чего начать
| Документ | Когда читать |
|---|---|
| architecture.md | Понять устройство: процессы, путь трафика, слои, хранилища, метрики |
| deployment.md | Первый деплой edge-ноды и manager'а |
| configuration.md | Все поля config.toml и переменные окружения Manager |
| development.md | Правила кода, тестов, гейты и Definition of Done |
2. Эксплуатация (how-to)
| Документ | О чём |
|---|---|
| runbook.md | Метрики, рестарты, снятие банов, аварийные процедуры |
| troubleshooting.md | Диагностика типовых проблем |
| disaster_recovery.md | Восстановление после отказа Redis/ноды |
| testing.md | Гейты, тесты, XDP-smoke на реальном ядре |
3. Справочник (reference)
| Документ | О чём |
|---|---|
| configuration.md | Все поля конфига, границы и значения по умолчанию |
| api.md | HTTP API manager'а: аутентификация, эндпоинты, лимиты |
| vds_compatibility.md | Ограничения окружений и ядер |
4. Планы и процесс
| Документ | О чём |
|---|---|
| roadmap/README.md | Индекс задач по версиям, статусы, правила ведения |
| roadmap/ | По одному файлу на задачу (v0.4, v0.5, v0.6, icebox) |
| development.md | KISS/DRY/SOLID, лимиты файлов, гейты, anti-patterns |
| ../TODO.md | Только текущий статус и ссылки на планы |
| ../CHANGELOG.md | Что и когда изменилось |
5. Протоколы
| Документ | О чём |
|---|---|
| minecraft-java.md | Minecraft-edge: Paper, PROXY protocol, закрытый backend |
6. Теория и исследования
| Раздел | О чём |
|---|---|
| kb/ | База знаний: анатомия атак, уровни защиты, практика (двуязычная) |
| research/ | Глубокие разборы: архитектура, eBPF, DDoS, Rust-производительность, конкуренты |
kb/ отвечает на вопрос «как это работает и как защищаться», research/ — на
вопрос «какое решение выбрать и почему». Статус проекта не живёт ни там, ни там —
только в TODO.md и roadmap/.
7. Как вести документацию
- Язык.
docs/— русский. Исключение: docs/kb/, где статьи двуязычные (## English/## Русский). Комментарии в коде — английский (development.md §5). - Один документ = одна задача. How-to начинается с цели («что получится в конце»), содержит копируемые команды и заканчивается проверкой результата.
- Reference синхронизируется с кодом в том же PR. Меняешь поле конфига, флаг
CLI или эндпоинт — правишь
configuration.md/api.mdтам же. Расхождение = баг. - Планы не растут в TODO. Новая задача — новый файл в
roadmap/; в
TODO.mdдобавляется только строка-ссылка. - Новый документ кладётся в подходящую категорию (1–6) и сразу добавляется в эту таблицу; если он является точкой входа — ссылка добавляется и в корневой README.
- Не размножай папки. Плоская структура
docs/*.md— норма; подпапка нужна только для серии документов (kb/,research/,roadmap/). - Имена файлов — kebab-case,
.md, без дат в имени; дата и версия — внутри документа. - Никаких битых ссылок. Перед коммитом:
bash scripts/check_docs_links.sh(этот же скрипт работает в CI). - Не дублируй архитектуру. Схемы и описания слоёв живут в architecture.md; остальные документы ссылаются на него.
Версия: 3.0 | Ноябрь 2026