docs: YAML vs docs audit — 37 services, all params match 1:1
This commit is contained in:
@@ -111,3 +111,27 @@ mkdocs-material не имеет встроенного `!include` для `nav:`.
|
|||||||
Альтернативы (отвергнуты):
|
Альтернативы (отвергнуты):
|
||||||
- docs-generator пишет полный mkdocs.yml (слишком хрупко)
|
- docs-generator пишет полный mkdocs.yml (слишком хрупко)
|
||||||
- mkdocs-awesome-pages (не решает проблему merge static+dynamic)
|
- 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-спеках, не влияют на корректность.
|
||||||
|
|||||||
Reference in New Issue
Block a user