From 99c30d49930c149e760c20af334935596719c4b7 Mon Sep 17 00:00:00 2001
From: Maksim Totmin <maksim@totmin.ru>
Date: Fri, 19 Jun 2026 20:59:34 +0700
Subject: [PATCH] docs: fix README formatting and add missing robot_id step

- Close unclosed YAML code block (table was inside it)
- Fix code block indentation inside numbered lists (3->4 spaces)
- Align comments in directory tree listing
- Add explicit robot_id step to 'Adding new scenario' guide
- Remove stale production IP from config example
---
 README.md | 40 +++++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index d539298..61166f3 100644
--- a/README.md
+++ b/README.md
@@ -59,9 +59,9 @@ Zabbix агент по запросу сервера запускает скри
 2. Привязать шаблон к хосту (Configuration → Hosts → выберите хост → Templates)
 3. В конфиге монитора `config/config.yaml` установить `mode: "userparameter"`
 4. В `/etc/zabbix/zabbix_agentd.conf` добавить строку:
-   ```
-   Include=/opt/ses-monitor/config/zbx_agentd_ses.conf
-   ```
+    ```
+    Include=/opt/ses-monitor/config/zbx_agentd_ses.conf
+    ```
 5. Перезапустить Zabbix агента: `sudo systemctl restart zabbix-agent`
 
 ## Структура проекта
@@ -89,7 +89,7 @@ Zabbix агент по запросу сервера запускает скри
 ├── zabbix/
 │   ├── zbx_ses_template_5.0.xml       # Шаблон для sender (trapper)
 │   ├── zbx_ses_template_5.0_up.xml    # Шаблон для UserParameter
-│   └── zbx_ses_monitor.conf        # UserParameter для Zabbix агента
+│   └── zbx_ses_monitor.conf           # UserParameter для Zabbix агента
 ├── scripts/
 │   └── zbx_get.py              # Скрипт чтения JSON для UserParameter
 ├── systemd/
@@ -143,8 +143,8 @@ nano config/config.yaml
 
 ```yaml
 ses:
-  base_url: "http://10.101.60.31:6190"   # URL вашего SES API
-  channel: "monitoring"                  # Имя канала в архиве
+  base_url: "http://YOUR_SES_HOST:6190"  # URL вашего SES API
+  channel: "monitoring"                  # Канал для мониторинговых сессий
   request_timeout: 30
 
 zabbix:
@@ -195,7 +195,7 @@ journalctl -u ses-monitor -f
 ### Полный формат
 
 ```yaml
-# Имя сценария (используется в логах и ключах Zabbix)
+# Имя сценария (используется в логах)
 name: "example: проверка диалога"
 
 # Описание для документации
@@ -236,6 +236,7 @@ steps:
         equals: 0
       - path: "answer"
         not_empty: true
+```
 
 ### Условия проверки (expect)
 
@@ -266,22 +267,22 @@ path: "request.data[0].reply.confidence"
 ## Как адаптировать под ваш проект
 
 1. **Узнайте robot_id** вашего сценария:
-   ```bash
-   curl -s http://<ses-host>:6190/ses/robot/listall
-   ```
+    ```bash
+    curl -s http://<ses-host>:6190/ses/robot/listall
+    ```
 
 2. **Пропишите robot_id** в файле сценария (поле `robot_id` в YAML)
 
 3. **Создайте файл сценария**, описав шаги диалога:
-   ```bash
-   cp config/scenarios/example_liveness.yaml config/scenarios/$(hostname).yaml
-   vim config/scenarios/$(hostname).yaml
-   ```
+    ```bash
+    cp config/scenarios/example_liveness.yaml config/scenarios/$(hostname).yaml
+    vim config/scenarios/$(hostname).yaml
+    ```
 
 4. **Протестируйте вручную** шаги через curl:
-   ```bash
-   curl -X POST "http://<ses-host>:6190/ses/ask/<robot_id>?text=Привет&channel=monitoring"
-   ```
+    ```bash
+    curl -X POST "http://<ses-host>:6190/ses/ask/<robot_id>?text=Привет&channel=monitoring"
+    ```
 
 5. **Запустите демон** — метрики агрегируются автоматически (шаблон Zabbix универсален)
 
@@ -291,8 +292,9 @@ path: "request.data[0].reply.confidence"
 
 1. Создать `config/scenarios/my_scenario.yaml`
 2. Скопировать структуру из примеров
-3. Описать шаги и ожидания
-4. Сценарий автоматически подхватится через hot-reload (каждые 60 секунд)
+3. Указать `robot_id` вашего робота (узнать: `GET /ses/robot/listall`)
+4. Описать шаги и ожидания
+5. Сценарий автоматически подхватится через hot-reload (каждые 60 секунд)
 
 ### Добавление новой метрики