Документация

В каталоге docs/ репозитория SDK ведётся полная документация в семи разделах:

• Setup & Requirements — установка инструментов и проверка окружения;
• Architecture — структура SDK, компоненты, добавление платформ;
• Platforms — поддерживаемые MCU: STM32 F103 (основная), обзор RISC-V и ESP32;
• Building & CMake — тулчейны, флаги, типовые ошибки сборки;
• Build System & Docker — контейнерная и удалённая сборка, примеры CI/CD;
• Tools & Scripts — build.py, клиент удалённой сборки;
• Integration Guide — как подключить SDK к проекту как submodule.

Документация проекта хранится в корне репозитория:

• ARCHITECTURE.md — архитектура проекта и конвейер сборки;
• PROJECT_OVERVIEW.md — высокоуровневый обзор и процесс компиляции;
• PROJECT_STRUCTURE.md — назначение файлов и каталогов;
• USAGE_EXAMPLES.md — сценарии: новая плата, CI/CD, периферия;
• CMAKE_BUILD_DETAILS.md, CONFIGURATION_USAGE.md, CONFIGURATION_CHECKLIST.md — детали CMake и конфигураций.

Серверная часть сопровождается скриптами и комментариями; раздел «Build System & Docker» документации SDK описывает: контейнерный образ embedded-sdk-builder, серверные скрипты build.sh и build_in_container.sh, клиента remote_build.py и параметры сборки. Формирование отчётов info.txt/sections.txt с контрольными суммами задокументировано в самих скриптах.

• README.md — установка и сетевые порты координатора;
• docs/AUTHENTIK_SETUP.md — настройка Authentik для выпуска JWT (HS256), scope и маппинги прав;
• документация в коде: менеджеры симуляции, радиоэфира, шин, питания и UART снабжены docstring-комментариями.

README содержит стандартное описание Flutter-проекта. Фактическая документация по функциональности содержится в исходном коде: сервис координатора (coordinator_service.dart) описывает протокол сообщений, auth_service.dart — OAuth2-поток, экраны в каталоге lib/screens/ отражают состав интерфейса.

Ключевые архитектурные описания: ARCHITECTURE.md в Device Blink (компоненты, данные, конвейер сборки, добавление плат) и docs/02-architecture.md в Embedded SDK (модули и их ответственность). Диаграмма и слои на сайте соответствуют этим документам.