From d3d53c8b8de907f1d994b9c379f6c7f439637ca7 Mon Sep 17 00:00:00 2001 From: xintaofei Date: Thu, 2 Apr 2026 14:51:23 +0800 Subject: [PATCH] docs: add animated communication flow diagram to README Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 4 + docs/images/communication-flow.svg | 158 +++++++++++++++++++++++++++++ docs/readme/README.ar.md | 4 + docs/readme/README.de.md | 4 + docs/readme/README.es.md | 4 + docs/readme/README.fr.md | 4 + docs/readme/README.ja.md | 4 + docs/readme/README.ko.md | 4 + docs/readme/README.pt.md | 4 + docs/readme/README.zh-CN.md | 4 + docs/readme/README.zh-TW.md | 4 + 11 files changed, 198 insertions(+) create mode 100644 docs/images/communication-flow.svg diff --git a/README.md b/README.md index bceb31b..a422cf1 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,10 @@ remote development from any browser — with conversation aggregation, parallel development, MCP/Skills management, chat channel interactions (Telegram, Lark, iLink, etc.), and integrated Git/file/terminal workflows. +## Communication Flow + +![Communication Flow](./docs/images/communication-flow.svg) + ## Main Interface ![Codeg Light](./docs/images/main-light.png#gh-light-mode-only) ![Codeg Dark](./docs/images/main-dark.png#gh-dark-mode-only) diff --git a/docs/images/communication-flow.svg b/docs/images/communication-flow.svg new file mode 100644 index 0000000..0bf34b6 --- /dev/null +++ b/docs/images/communication-flow.svg @@ -0,0 +1,158 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Users + + + + CLIENTS + + + + + Web Browser + + + + + Desktop App + + + + + Telegram + + + + + Lark (Feishu) + + + + + iLink (Weixin) + + More channels ... + + + + + + + + + + + + Codeg + Unified Hub + + + + AI CODING AGENTS + + + + + Claude Code + + + + + Codex CLI + + + + + OpenCode + + + + + Gemini CLI + + + + + OpenClaw + + + + + Cline + + More agents ... + + diff --git a/docs/readme/README.ar.md b/docs/readme/README.ar.md index a75d8fe..e46d6a4 100644 --- a/docs/readme/README.ar.md +++ b/docs/readme/README.ar.md @@ -24,6 +24,10 @@ Codeg (Code Generation) هو مساحة عمل مؤسسية متعددة الو OpenClaw، وغيرها) في تطبيق سطح مكتب أو خادم مستقل أو حاوية Docker — مما يتيح التطوير عن بُعد من أي متصفح — مع تجميع المحادثات، والتطوير المتوازي عبر `git worktree`، وإدارة MCP/Skills، والتفاعل عبر قنوات الدردشة (Telegram وLark وiLink وغيرها)، وسير عمل متكامل لـ Git/الملفات/الطرفية. +## تدفق الاتصال + +![تدفق الاتصال](../images/communication-flow.svg) + ## الواجهة الرئيسية ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.de.md b/docs/readme/README.de.md index 3186805..1575ef1 100644 --- a/docs/readme/README.de.md +++ b/docs/readme/README.de.md @@ -27,6 +27,10 @@ Docker-Container — Remote-Entwicklung von jedem Browser aus — mit Konversati paralleler `git worktree`-Entwicklung, MCP/Skills-Verwaltung, Chat-Kanal-Integration (Telegram, Lark, iLink usw.) und integrierten Git/Datei/Terminal-Workflows. +## Kommunikationsfluss + +![Kommunikationsfluss](../images/communication-flow.svg) + ## Hauptoberfläche ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.es.md b/docs/readme/README.es.md index e99dcc0..046c1d9 100644 --- a/docs/readme/README.es.md +++ b/docs/readme/README.es.md @@ -27,6 +27,10 @@ o contenedor Docker — permitiendo el desarrollo remoto desde cualquier navegad de conversaciones, desarrollo paralelo con `git worktree`, gestión de MCP/Skills, interacción con canales de chat (Telegram, Lark, iLink, etc.) y flujos integrados de Git/archivos/terminal. +## Flujo de comunicación + +![Flujo de comunicación](../images/communication-flow.svg) + ## Interfaz principal ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.fr.md b/docs/readme/README.fr.md index 66356b0..b35c35b 100644 --- a/docs/readme/README.fr.md +++ b/docs/readme/README.fr.md @@ -26,6 +26,10 @@ Docker — permettant le développement à distance depuis n'importe quel naviga parallèle via `git worktree`, gestion MCP/Skills, interaction avec les canaux de chat (Telegram, Lark, iLink, etc.) et workflows intégrés Git/fichiers/terminal. +## Flux de communication + +![Flux de communication](../images/communication-flow.svg) + ## Interface principale ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.ja.md b/docs/readme/README.ja.md index e99b00d..654605d 100644 --- a/docs/readme/README.ja.md +++ b/docs/readme/README.ja.md @@ -24,6 +24,10 @@ Claude Code、Codex CLI、OpenCode、Gemini CLI、OpenClaw などのローカル デスクトップアプリ、スタンドアロンサーバー、または Docker コンテナに統合し——ブラウザからどこでもリモート開発が可能——会話集約、並列 `git worktree` 開発、MCP/Skills 管理、 チャットチャンネル連携（Telegram、Lark、iLink など）、Git/ファイル/ターミナル連携ワークフローを提供します。 +## 通信フロー + +![通信フロー](../images/communication-flow.svg) + ## メインインターフェース ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.ko.md b/docs/readme/README.ko.md index c1bde27..dc5ab49 100644 --- a/docs/readme/README.ko.md +++ b/docs/readme/README.ko.md @@ -24,6 +24,10 @@ Claude Code, Codex CLI, OpenCode, Gemini CLI, OpenClaw 등 로컬 AI 코딩 Agen 데스크톱 앱, 독립형 서버 또는 Docker 컨테이너로 통합하여 — 브라우저만으로 어디서든 원격 개발이 가능하며 — 대화 집계, 병렬 `git worktree` 개발, MCP/Skills 관리, 채팅 채널 연동(Telegram, Lark, iLink 등), Git/파일/터미널 통합 워크플로를 제공합니다. +## 통신 흐름 + +![통신 흐름](../images/communication-flow.svg) + ## 메인 인터페이스 ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.pt.md b/docs/readme/README.pt.md index 3b40817..62af52d 100644 --- a/docs/readme/README.pt.md +++ b/docs/readme/README.pt.md @@ -26,6 +26,10 @@ Docker — possibilitando o desenvolvimento remoto a partir de qualquer navegado paralelo via `git worktree`, gerenciamento de MCP/Skills, interação com canais de chat (Telegram, Lark, iLink, etc.) e fluxos integrados de Git/arquivos/terminal. +## Fluxo de comunicação + +![Fluxo de comunicação](../images/communication-flow.svg) + ## Interface principal ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.zh-CN.md b/docs/readme/README.zh-CN.md index 3e15c4f..e643134 100644 --- a/docs/readme/README.zh-CN.md +++ b/docs/readme/README.zh-CN.md @@ -24,6 +24,10 @@ Codeg（Code Generation）是一个企业级多 Agent 编码工作台。 OpenClaw、Cline 等）统一到桌面应用、独立服务器或 Docker 容器中——通过浏览器即可远程开发——支持对话聚合、 并行 `git worktree` 开发、MCP/Skills 管理、消息渠道交互（Telegram、飞书、iLink 等），以及集成的 Git/文件/终端工作流。 +## 通信流程 + +![通信流程](../images/communication-flow.svg) + ## 主界面 ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only) diff --git a/docs/readme/README.zh-TW.md b/docs/readme/README.zh-TW.md index c8184bb..82665ec 100644 --- a/docs/readme/README.zh-TW.md +++ b/docs/readme/README.zh-TW.md @@ -24,6 +24,10 @@ Codeg（Code Generation）是一個企業級多 Agent 編碼工作台。 OpenClaw、Cline 等）整合到桌面應用、獨立伺服器或 Docker 容器中——透過瀏覽器即可遠端開發——支援對話彙整、並行 `git worktree` 開發、MCP/Skills 管理、訊息渠道互動（Telegram、飛書、iLink 等），以及整合的 Git/檔案/終端工作流。 +## 通訊流程 + +![通訊流程](../images/communication-flow.svg) + ## 主介面 ![Codeg Light](../images/main-light.png#gh-light-mode-only) ![Codeg Dark](../images/main-dark.png#gh-dark-mode-only)