Files

T

Repinoid 2c196e8cc8 docs(history): раскладка HISTORY по тематическим папкам (75 файлов)

Было: 41 файл в корне HISTORY/ + авторские папки OPUS/ и SONNET/ (34 файла).
Стало — тематическая нумерация в стиле NOTES/ (10_, 20_, …):

  10_reviews/    ревью кода и разборы от LLM (2)
  20_releases/   заливки версий в реестр, чистки реестра, нумерация версий (8)
  30_provider/   ядро провайдера: архитектура, модификаторы, UUID, nested (6)
  40_generator/  генератор YAML/спеки, формат MAN (3)
  50_docs/       пайплайн документации, навигация, публикация, хостинг S3 (9)
  60_stands/     стенды и примеры: CRUD, FullPipe, Штурвал, TEST_STAND (7)
  70_infra/      реестр, API Gateway, DDoS-Guard, VPN/213, зеркала (4)
  90_llm/        диалоги и промпты с LLM вне тематики: OPUS/, SONNET/, gemini/ (34)

OPUS/ и SONNET/ перенесены как есть в 90_llm/ — чтобы не рвать пары
«бриф → ответ» внутри диалогов. Все переносы — через git mv (история сохранена).
Перед правкой: TMP/backup_2026-10-02/HISTORY_before_restructure.tar.gz.
Перекрёстные ссылки обновляются следующим коммитом.

2026-10-02 07:35:32 +03:00

1.9 KiB

Raw Blame History

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 строк) + полный в
Секция «Быстрый старт» перед MAN

Слой 3: mkdocs — P3

Sidebar по категориям (Базы данных / K8s / Хранилище / ...)
Хлебные крошки
Убрать inline-навигацию (заменяет sidebar)
Back/Next кнопки

Порядок реализации

LLM промпт — мгновенный эффект на все 34 сервиса
renderParamTable — убрать ID, раскрыть constraints
buildExamplePage — двойной пример
mkdocs nav — категории в sidebar

1.9 KiB Raw Blame History