[Taiga #9] Документировать архитектуру project-agent и OpenClaw в README #1

Open
opened 2026-05-18 23:17:09 +00:00 by Grigo · 0 comments
Owner

Linked Taiga story: #9

Suggested branch:
feature/taiga-9-dokumentirovat-arhitekturu-project-agent-i-openclaw-v-readme

Project type: home
AI tags: home, sandbox, setup, documentation, architecture, project-agent, openclaw

Description

Необходимо описать текущую архитектуру системы в README.md. Project-agent — это FastAPI-сервис, работающий в Docker контейнере, который управляет репозиториями и взаимодействует с OpenClaw. Нужно объяснить компоненты, взаимодействие между ними, назначение директорий и как система интегрируется с OpenClaw.

Taiga: https://tasks.grigowashere.ru/project//us/9

Acceptance criteria

  • В README.md описана архитектура project-agent с указанием основных компонентов
  • Документирована роль FastAPI сервера и его API endpoints
  • Объяснено взаимодействие project-agent с OpenClaw
  • Описаны назначения директорий: /repos, /state, /logs, /ssh
  • Указаны переменные окружения и их назначение (AGENT_*)
  • Документирована безопасность: ограничения на git push, delete, jenkins build
  • Описана интеграция через docker-compose и сетевое взаимодействие
  • README содержит инструкции по запуску и развёртыванию

Code notes

  • В Dockerfile используется Python 3.12-slim, установлены git, openssh-client и другие инструменты для работы с репозиториями
  • docker-compose.yml показывает, что сервис работает на порту 8787, маундирует несколько критичных директорий и использует внешнюю сеть ai-internal
  • Environment переменные AGENT_ALLOW_* установлены в false для безопасности по умолчанию
  • requirements.txt содержит FastAPI, uvicorn, GitPython — это базис для работы с репозиториями
  • В server.py упоминаются README.md и readme.md (строки 121-122), что может указывать на работу с документацией проектов
  • Директория skills/project-agent содержит SKILL.md — нужно проверить этот файл для понимания интеграции с OpenClaw

Questions

  • Какие основные API endpoints предоставляет project-agent? Проверить server.py полностью для полного списка.
  • Как точно project-agent интегрируется с OpenClaw? Есть ли документация в skills/project-agent/SKILL.md?
  • Какова роль config.yml в app/? Какие параметры там настраиваются?
  • Есть ли примеры запросов к project-agent, которые нужно задокументировать?
Linked Taiga story: #9 Suggested branch: `feature/taiga-9-dokumentirovat-arhitekturu-project-agent-i-openclaw-v-readme` Project type: `home` AI tags: home, sandbox, setup, documentation, architecture, project-agent, openclaw ## Description Необходимо описать текущую архитектуру системы в README.md. Project-agent — это FastAPI-сервис, работающий в Docker контейнере, который управляет репозиториями и взаимодействует с OpenClaw. Нужно объяснить компоненты, взаимодействие между ними, назначение директорий и как система интегрируется с OpenClaw. Taiga: https://tasks.grigowashere.ru/project//us/9 ## Acceptance criteria - В README.md описана архитектура project-agent с указанием основных компонентов - Документирована роль FastAPI сервера и его API endpoints - Объяснено взаимодействие project-agent с OpenClaw - Описаны назначения директорий: /repos, /state, /logs, /ssh - Указаны переменные окружения и их назначение (AGENT_*) - Документирована безопасность: ограничения на git push, delete, jenkins build - Описана интеграция через docker-compose и сетевое взаимодействие - README содержит инструкции по запуску и развёртыванию ## Code notes - В Dockerfile используется Python 3.12-slim, установлены git, openssh-client и другие инструменты для работы с репозиториями - docker-compose.yml показывает, что сервис работает на порту 8787, маундирует несколько критичных директорий и использует внешнюю сеть ai-internal - Environment переменные AGENT_ALLOW_* установлены в false для безопасности по умолчанию - requirements.txt содержит FastAPI, uvicorn, GitPython — это базис для работы с репозиториями - В server.py упоминаются README.md и readme.md (строки 121-122), что может указывать на работу с документацией проектов - Директория skills/project-agent содержит SKILL.md — нужно проверить этот файл для понимания интеграции с OpenClaw ## Questions - Какие основные API endpoints предоставляет project-agent? Проверить server.py полностью для полного списка. - Как точно project-agent интегрируется с OpenClaw? Есть ли документация в skills/project-agent/SKILL.md? - Какова роль config.yml в app/? Какие параметры там настраиваются? - Есть ли примеры запросов к project-agent, которые нужно задокументировать?
Grigo added the homesandboxsetupdocumentationarchitectureproject-agentopenclaw labels 2026-05-18 23:17:11 +00:00
Sign in to join this conversation.