“Naeel”
c9a881aa84
- value_list → читаемый текст (Допустимые значения) - regex → описание формата - пустые описания → заполнять из MAN - группы map-fixed → 1 предложение о содержимом - операции без описания → шаблоны - MAN-контекст для params/ops файлов - max_tokens 4096 → 8192 - вывод в docs_llm/ вместо перезаписи docs/
37 lines
1.9 KiB
Markdown
37 lines
1.9 KiB
Markdown
# Sonnet: ответ по улучшению документации
|
|
|
|
## Принцип: «User Journey First» — 4 сценария
|
|
|
|
A. «Хочу задеплоить» → описание (30s) → минимальный пример (1m) → apply
|
|
B. «Хочу настроить параметр» → справка с читаемыми constraints
|
|
C. «Хочу использовать output» → outputs + HCL-примеры
|
|
D. «Хочу modify/restart/suspend» → страница операций
|
|
|
|
## Изменения по 3 слоям
|
|
|
|
### Слой 1: LLM-промпт — P1 (макс. польза, 0 компиляции)
|
|
- Раскрывать `value_list` → «Допустимые значения: 1, 3, 5, 7»
|
|
- Раскрывать `regex` → «Формат: cron»
|
|
- Заполнять пустые описания из MAN
|
|
- Группы (clusterConfiguration) — 1 предложение из MAN
|
|
- Операции — заполнять «—» из MAN
|
|
- Заменять TODO в примерах на реальные значения
|
|
|
|
### Слой 2: docs-generator (Go) — P2
|
|
- Убрать колонку ID
|
|
- value_list → читаемый текст
|
|
- Двойной пример: минимальный (15 строк) + полный в <details>
|
|
- Секция «Быстрый старт» перед MAN
|
|
|
|
### Слой 3: mkdocs — P3
|
|
- Sidebar по категориям (Базы данных / K8s / Хранилище / ...)
|
|
- Хлебные крошки
|
|
- Убрать inline-навигацию (заменяет sidebar)
|
|
- Back/Next кнопки
|
|
|
|
## Порядок реализации
|
|
1. LLM промпт — мгновенный эффект на все 34 сервиса
|
|
2. renderParamTable — убрать ID, раскрыть constraints
|
|
3. buildExamplePage — двойной пример
|
|
4. mkdocs nav — категории в sidebar
|