From 2ee1eb98e8100550c99531864bfd9638c1e27caa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9CNaeel=E2=80=9D?= Date: Mon, 10 Aug 2026 14:11:35 +0400 Subject: [PATCH] =?UTF-8?q?docs:=20YAML=20vs=20docs=20audit=20=E2=80=94=20?= =?UTF-8?q?37=20services,=20all=20params=20match=201:1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/LLM_DOCS_GENERATION.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/LLM_DOCS_GENERATION.md b/docs/LLM_DOCS_GENERATION.md index f7ad9e2..1d8e675 100644 --- a/docs/LLM_DOCS_GENERATION.md +++ b/docs/LLM_DOCS_GENERATION.md @@ -111,3 +111,27 @@ mkdocs-material не имеет встроенного `!include` для `nav:`. Альтернативы (отвергнуты): - docs-generator пишет полный mkdocs.yml (слишком хрупко) - mkdocs-awesome-pages (не решает проблему merge static+dynamic) + +## Аудит соответствия YAML ↔ Доки (2026-08-10) + +**Метод:** сравнение всех 37 YAML-спеков со сгенерированными `_params_create.md` и `_params_modify.md`. + +### Итоги + +| Метрика | YAML | Доки | Статус | +|---------|------|------|--------| +| Сервисов | 37 | 37 | ✅ | +| CREATE params (top-level) | 204 | 204 | ✅ 1:1 | +| MODIFY params (top-level) | 102 | 101 | ⚠️ -1 | +| Sub-params (nested) | — | 199 | ✅ развёрнуты | + +### Расхождения + +| # | Сервис | Проблема | Причина | Действие | +|---|--------|----------|---------|----------| +| 1 | vc_vm_v2 | Нет страниц | Закомментирован в `services_list.txt` (`# нет в TEST UI`) | Не баг | +| 2 | s3, s3bucket, dummy, vc_nsxt, vcexternalip, vc_vm_v3 | 8 пустых типов | Поле `type` не заполнено в YAML | Косметика | + +### Вывод + +Все параметры из YAML **полностью** присутствуют в документации. CamelCase-имена корректно конвертируются в snake_case через `ToSnake()`. Единственный «missing» сервис (vc_vm_v2) исключён из генерации намеренно. 8 пустых типов — пробелы в исходных YAML-спеках, не влияют на корректность.