README переверстан (docs/changes/024): быстрый старт, конфигурация одной таблицей, архитектура с деревом каталогов, функциональность и правила по разделам (таблица состояний «Upgrade ROS»), API по областям с соглашениями, безопасность, эксплуатация (в т.ч. копия БД в режиме WAL, стенд на порту 8001), интерфейс, тесты, история изменений таблицей со ссылками на план и итог, отчёты ревью. Повторы убраны. Все 51 ссылка на документы проверены; переменные, эндпоинты и число тестов сверены с кодом. Код не менялся. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2.2 KiB
2.2 KiB
Итоги: 024 — оптимизация README по образцу ipam_control
Сделано
- README переверстан по структуре
/opt/lvraid/claude/ipam_control/README.md: «Быстрый старт», «Конфигурация» (одна таблица), «Архитектура» (таблица слоёв и дерево каталогов), «Функциональность и правила» (полужирные подзаголовки, таблица состояний «Upgrade ROS»), «Требования к устройствам», «API» (таблица по областям и «Соглашения»), «Безопасность», «Эксплуатация», «Интерфейс», «Тесты», «История изменений» (таблица со ссылками наplan.md/summary.md001–024), «Отчёты ревью». - Убраны повторы: требования к секретам и команды генерации — по одному месту; длинные описания истории изменений — в документах изменений.
- Добавлено: раздел «Отчёты ревью», копирование БД в режиме WAL (замечание 13 повторного ревью, только документация), текущий стенд на порту 8001,
коды ошибок API (включая 401), синхронность смены канала одного устройства и
refresh.
Проверено
- Все 51 ссылка (49 на
docs/changes/*, 2 наdocs/reviews/*) указывают на существующие файлы. - Переменные
.envсверены сapp/config.py, эндпоинты — сapp/api/v1.py, число тестов (33) — сpytest --collect-only. - Код не менялся, стенд не пересобирался.
Оговорки
- Документы изменений в этом проекте названы
plan.md/summary.md(в образце —PLAN.md/SUMMARY.md); регистр сохранён как есть.