0 Fork 0

Files

T

ayurishchevandClaude Opus 5.5 7c830be721 README по образцу ipam_control

README переверстан (docs/changes/024): быстрый старт, конфигурация одной
таблицей, архитектура с деревом каталогов, функциональность и правила по
разделам (таблица состояний «Upgrade ROS»), API по областям с
соглашениями, безопасность, эксплуатация (в т.ч. копия БД в режиме WAL,
стенд на порту 8001), интерфейс, тесты, история изменений таблицей со
ссылками на план и итог, отчёты ревью. Повторы убраны.

Все 51 ссылка на документы проверены; переменные, эндпоинты и число
тестов сверены с кодом. Код не менялся.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

2026-09-28 17:32:37 +03:00

3.5 KiB

Raw Permalink Blame History

План: 024 — оптимизация README по образцу ipam_control

Context

README вырос за 23 изменения: длинные абзацы, повторы (требования к секретам — в трёх разделах, генерация ключей — в двух), история изменений — список с длинными описаниями без ссылок на документы, нет раздела об отчётах ревью, эксплуатационные сведения (том, миграции, один процесс, WAL) разбросаны. Пользователь просит переверстать README по образцу /opt/lvraid/claude/ipam_control/README.md.

Изменения (только `README.md`)

Структура образца:

Заголовок и абзац о проекте (+ схема компонентов).
Быстрый старт — команды и адреса UI/OpenAPI, вход.
Конфигурация (.env) — одна таблица «Переменная | По умолчанию | Назначение», требования к секретам — только здесь и в «Безопасности».
Архитектура — таблица слоёв и дерево каталогов.
Функциональность и правила — полужирные подзаголовки: устройства, состояния «Upgrade ROS», группы и фильтры, операции и задачи, бэкапы, откат ROS, идентификаторы, журнал событий.
Требования к устройствам.
API (/api/v1) — таблица по областям + «Соглашения».
Безопасность — секреты, вход, cookie, шифрование, секреты в бэкапах.
Эксплуатация — контейнер и том, миграции, один процесс, кэш бакета, копирование БД в режиме WAL (замечание 13 повторного ревью — только документация), текущий стенд на порту 8001.
Интерфейс — короткий список.
Тесты — команда и число тестов.
История изменений — таблица «№ | Изменение | Документы» со ссылками на plan.md/summary.md (001–024).
Отчёты ревью — ссылки на docs/reviews/ с указанием, в какие изменения они вылились.

Содержание не теряется: каждое утверждение текущего README переносится в свой раздел (сверка списком фактов при ревью).

Исполнение

Только документация — оркестратор сам (навык change-flow: документация без исполнителя). Код не меняется, стенд не пересобирается.

Проверка

Все ссылки на docs/changes/*/plan.md|summary.md и docs/reviews/*.md указывают на существующие файлы (скрипт).
Сверка фактов: переменные .env из app/config.py, эндпоинты из app/api/v1.py, число тестов из pytest --collect-only.

3.5 KiB Raw Permalink Blame History Unescape Escape