feat: update documentation structure and add new content for Lightweight Cobot

2026-05-23 12:51:56 +03:00
parent 490f8823a5
commit 50d248eb0c
33 changed files with 144 additions and 18 deletions
@@ -0,0 +1,3 @@
+# Потоки данных
+
+*Как данные идут от FRI до MoveIt: топики, сервисы, action-серверы.*
@@ -0,0 +1,3 @@
+# iiwa_bringup
+
+*Launch-файлы, точка входа системы.*
@@ -0,0 +1,3 @@
+# iiwa_config
+
+*URDF, SRDF, параметры контроллеров.*
@@ -0,0 +1,3 @@
+# iiwa_controller
+
+*Аппаратный интерфейс FRI: SystemInterface, контроллеры.*
@@ -0,0 +1,3 @@
+# iiwa_description
+
+*Визуальная и кинематическая модель робота.*
@@ -0,0 +1,3 @@
+# iiwa_msgs
+
+*Кастомные сообщения и сервисы.*
@@ -0,0 +1,3 @@
+# iiwa_planning
+
+*MoveIt, планирование траекторий, конфигурация планировщиков.*
@@ -0,0 +1,3 @@
+# iiwa_sunrise
+
+*Мост с Java-кодом Sunrise Workbench.*
@@ -0,0 +1,3 @@
+# iiwa_utils
+
+*Вспомогательные утилиты.*
@@ -0,0 +1,3 @@
+# RealSense
+
+*Пакеты камеры: драйвер, сообщения, MQTT-мост.*
@@ -0,0 +1,3 @@
+# Обзор системы
+
+*Диаграмма: робот ↔ FRI ↔ ROS2 ↔ интерфейсы управления.*
@@ -0,0 +1,3 @@
+# Foxglove Studio
+
+*Подключение, полезные панели, отправка команд.*
@@ -0,0 +1,3 @@
+# Симуляция
+
+*Запуск в Webots и RViz.*
@@ -0,0 +1,3 @@
+# Терминал (ROS2 CLI)
+
+*`ros2 topic`, `ros2 action`, `ros2 service` — шпаргалка.*
@@ -0,0 +1,3 @@
+# Web-интерфейс
+
+*В разработке.*
@@ -0,0 +1,3 @@
+# Сборка и пересборка
+
+*`cobot rebuild`, `cobot clean`, `cobot update`.*
@@ -0,0 +1,3 @@
+# Справочник CLI
+
+*Полный список команд `cobot` с параметрами.*
@@ -0,0 +1,3 @@
+# Решение проблем
+
+*Частые ошибки и способы их исправления.*
@@ -0,0 +1,3 @@
+# Декартова цель (pose)
+
+*Пример задания цели в пространстве через MoveIt.*
@@ -0,0 +1,3 @@
+# Движение в позицию по осям
+
+*Пример отправки joint position goal.*
@@ -0,0 +1,3 @@
+# MoveIt Python API
+
+*Управление роботом из Python-скрипта.*
@@ -0,0 +1,3 @@
+# Чтение данных RealSense
+
+*Получение изображений и облака точек.*
@@ -0,0 +1,3 @@
+# Выполнение траектории
+
+*Пример составной траектории.*
@@ -0,0 +1,3 @@
+# Настройка
+
+*`cobot robot-setup` и описание полей `cobot-setting.yaml`.*
@@ -0,0 +1,3 @@
+# Ручная установка
+
+*Нативная установка ROS2, Docker, Webots.*
@@ -0,0 +1,3 @@
+# Обзор
+
+*Описание проекта, что это такое и зачем.*
@@ -0,0 +1,3 @@
+# Быстрый старт
+
+*Установка одной командой и первый запуск.*
@@ -0,0 +1,3 @@
+# Загрузка на контроллер
+
+*Сборка и деплой приложения на робота.*
@@ -0,0 +1,3 @@
+# Настройка сети
+
+*FRI-соединение, IP-адреса и порты.*
@@ -0,0 +1,3 @@
+# Обзор Sunrise Workbench
+
+*Что такое FRI и зачем нужен Sunrise Workbench.*
@@ -0,0 +1,3 @@
+# Настройка проекта
+
+*Импорт проекта, зависимости и библиотеки.*
@@ -4,6 +4,7 @@ site_author: Даниил Грабарь

 theme:
  name: material
+  custom_dir: overrides
  language: ru
  features:
    - navigation.tabs
@@ -18,7 +19,7 @@ plugins:
  - with-pdf:
      author: Даниил Грабарь
      cover_title: Документация LWC
-      cover_subtitle: KUKA LBR iiwa7 ROS2 Control Framework
+      cover_subtitle: Lightweight Cobot
      output_path: pdf/document.pdf

 extra_javascript:
@@ -32,23 +33,46 @@ markdown_extensions:
 nav:
  - Главная: index.md

-  # - Обзор проекта:
-  #   - Введение: overview/intro.md
-  #   - Архитектура: overview/architecture.md
-  #   - Зависимости: overview/dependencies.md
+  - Getting Started:
+    - Обзор: getting-started/overview.md
+    - Быстрый старт: getting-started/quick-start.md
+    - Ручная установка: getting-started/manual-install.md
+    - Настройка: getting-started/configuration.md

-  # - Установка:
-  #   - Требования: install/requirements.md
-  #   - ROS2: install/ros2.md
-  #   - KUKA FRI: install/fri.md
+  - Sunrise Workbench:
+    - Обзор: sunrise/overview.md
+    - Настройка проекта: sunrise/project-setup.md
+    - Настройка сети: sunrise/network.md
+    - Загрузка на контроллер: sunrise/deployment.md

-  # - Разработка:
-  #   - Структура пакетов: dev/packages.md
-  #   - Камеры RealSense: dev/realsense.md
-  #   - Управление KUKA: dev/kuka.md
-  #   - Сборка: dev/build.md
+  - Architecture:
+    - Обзор системы: architecture/system-overview.md
+    - Пакеты:
+      - iiwa_controller: architecture/packages/iiwa-controller.md
+      - iiwa_bringup: architecture/packages/iiwa-bringup.md
+      - iiwa_planning: architecture/packages/iiwa-planning.md
+      - iiwa_msgs: architecture/packages/iiwa-msgs.md
+      - iiwa_config: architecture/packages/iiwa-config.md
+      - iiwa_description: architecture/packages/iiwa-description.md
+      - iiwa_sunrise: architecture/packages/iiwa-sunrise.md
+      - iiwa_utils: architecture/packages/iiwa-utils.md
+      - RealSense: architecture/packages/realsense.md
+    - Потоки данных: architecture/data-flow.md

-  # - API:
-  #   - Обзор: api/overview.md
-  #   - Топики: api/topics.md
-  #   - Сервисы: api/services.md
+  - Control:
+    - Foxglove Studio: control/foxglove.md
+    - Терминал: control/terminal.md
+    - Web-интерфейс: control/web-interface.md
+    - Симуляция: control/simulation.md
+
+  - Examples:
+    - Joint Position: examples/joint-position.md
+    - Cartesian Goal: examples/cartesian-goal.md
+    - Траектория: examples/trajectory.md
+    - MoveIt Python API: examples/moveit-python.md
+    - RealSense данные: examples/realsense-data.md
+
+  - Development:
+    - Сборка и пересборка: development/build-rebuild.md
+    - CLI Reference: development/cli-reference.md
+    - Решение проблем: development/troubleshooting.md
@@ -0,0 +1,9 @@
+<footer class="md-footer">
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-copyright">
+        &copy; 2026 &mdash; Lightweight Cobot
+      </div>
+    </div>
+  </div>
+</footer>