refactor: update setup wizard steps and documentation; remove overview section

2026-06-21 07:29:21 +03:00
parent a983a06e41
commit d26d60def4
12 changed files with 182 additions and 88 deletions
@@ -0,0 +1,48 @@
+# Обзор
+
+**Lightweight Cobot (LWC)** — открытая система управления коллаборативным роботом **KUKA LBR IIWA 7 R800** на базе **ROS 2 Jazzy**. Поддерживает работу как с физическим роботом (через протокол FRI), так и в виртуальной среде (симулятор Webots). В состав проекта входят CLI-инструмент `cobot`, аппаратный интерфейс ROS 2 Control, планировщик движений MoveIt 2 и REST/MCP API для интеграции с AI-агентами.
+
+---
+
+## Репозитории
+
+| Платформа | Ссылка | Статус |
+|---|---|---|
+| **GitVerse** (предпочтительный) | [daniel-robotics/lightweight-cobot](https://gitverse.ru/daniel-robotics/lightweight-cobot) | основной |
+| GitHub | [Daniel-Robotic/lightweight-cobot](https://github.com/Daniel-Robotic/lightweight-cobot) | зеркало |
+
+## Онлайн документация
+
+- [GitVerse Pages](https://daniel-robotics.gitverse.site/lightweight-cobot) — основная
+- [GitHub Pages](https://daniel-robotic.github.io/lightweight-cobot/) — зеркало
+
+---
+
+## Предпосылки
+
+- Физический робот **KUKA LBR IIWA 7 R800** — если планируете работу с реальным оборудованием
+- Либо желание работать только в симуляторе **Webots** — физический робот не нужен
+- ПК или сервер с **Ubuntu 24.04** (или подключение к существующему серверу по SSH)
+- Доступ к сети, в которой находится контроллер робота
+
+---
+
+## Порядок шагов
+
+1. [**Настройка SunriseWorkbench**](sunrise-setup.md) — подготовка контроллера KUKA: подключение кабелей, загрузка программы `ServerFriRos2`, настройка сетевых параметров. *(Только для физического робота)*
+
+2. [**Подключение к серверу**](remote-access.md) — выбор варианта развёртывания (локально или удалённо), SSH-подключение к серверу управления.
+
+3. [**Установка проекта**](installation.md) — скачивание и установка LWC через `curl`, `git` или вручную. После установки запустите `cobot setup` — мастер проведёт по оставшимся шагам автоматически.
+
+4. [**Конфигурация системы**](configuration.md) — настройка `cobot-setting.yaml`: IP робота, порты, инструменты. Выполняется на шаге 2 мастера `cobot setup`, либо в любой момент позже через `cobot robot-setup`.
+
+5. [**CLI-инструмент cobot**](cli-reference.md) — все команды управления проектом: запуск, сборка, обновление.
+
+---
+
+!!! tip "Только симуляция?"
+    Если физический робот недоступен, пропустите шаг 1 и начните сразу с [установки проекта](installation.md). Запустите симулятор командой `cobot run --simulate`.
+
+!!! info "`cobot setup` сделает шаги 3–4 автоматически"
+    После установки проекта достаточно выполнить `cobot setup` — мастер последовательно предложит: настройку документации, параметры робота (`cobot-setting.yaml`) и выбор среды сборки (ROS2 или Docker).