mirror of
https://github.com/Egonex-AI/Understand-Anything.git
synced 2026-06-22 10:58:03 +08:00
docs: add "Share the Graph with Your Team" section to READMEs (#79)
This commit is contained in:
Lum1104
@@ -247,6 +247,31 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und
|
||||
|
||||
---
|
||||
|
||||
## 📦 Comparte el Grafo con tu Equipo
|
||||
|
||||
El grafo es solo JSON — **confírmalo una vez y tus compañeros se saltan el pipeline**. Ideal para onboarding, revisiones de PR y flujos docs-as-code.
|
||||
|
||||
> **Ejemplo:** [GoogleCloudPlatform/microservices-demo (fork)](https://github.com/Lum1104/microservices-demo) — referencia políglota (Go / Java / Python / Node) con el grafo ya confirmado.
|
||||
|
||||
**Qué confirmar:** todo lo que hay en `.understand-anything/` *excepto* `intermediate/` y `diff-overlay.json` (archivos temporales locales).
|
||||
|
||||
```gitignore
|
||||
.understand-anything/intermediate/
|
||||
.understand-anything/diff-overlay.json
|
||||
```
|
||||
|
||||
**Mantenlo al día:** activa `/understand --auto-update` — un hook post-commit parchea el grafo de forma incremental, así cada commit llega con su grafo correspondiente. O vuelve a ejecutar `/understand` manualmente antes de cada release.
|
||||
|
||||
**Grafos grandes (10 MB o más):** úsalos con **git-lfs**.
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs track ".understand-anything/*.json"
|
||||
git add .gitattributes .understand-anything/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Bajo el Capó
|
||||
|
||||
### Pipeline Multi-Agente
|
||||
|
||||
@@ -248,6 +248,31 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und
|
||||
|
||||
---
|
||||
|
||||
## 📦 チームでグラフを共有する
|
||||
|
||||
グラフは単なる JSON ファイルです——**一度コミットすれば、チームメンバーはパイプラインを実行せずに済みます**。オンボーディング、PR レビュー、docs-as-code ワークフローに最適です。
|
||||
|
||||
> **例：** [GoogleCloudPlatform/microservices-demo（fork）](https://github.com/Lum1104/microservices-demo) —— コミット済みのグラフを含む Go / Java / Python / Node のリファレンスプロジェクト。
|
||||
|
||||
**コミット対象：** `.understand-anything/` 内のすべてのファイル。ただし `intermediate/` と `diff-overlay.json` は除きます（これらはローカルの一時ファイルです）。
|
||||
|
||||
```gitignore
|
||||
.understand-anything/intermediate/
|
||||
.understand-anything/diff-overlay.json
|
||||
```
|
||||
|
||||
**最新状態を保つ：** `/understand --auto-update` を有効にすると、post-commit フックがグラフを増分的に更新し、各コミットに対応するグラフが揃います。またはリリース前に `/understand` を手動で再実行します。
|
||||
|
||||
**大きなグラフ（10 MB 以上）：** **git-lfs** で管理します。
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs track ".understand-anything/*.json"
|
||||
git add .gitattributes .understand-anything/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 内部の仕組み
|
||||
|
||||
### マルチエージェントパイプライン
|
||||
|
||||
@@ -247,6 +247,31 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und
|
||||
|
||||
---
|
||||
|
||||
## 📦 팀과 그래프 공유하기
|
||||
|
||||
그래프는 단지 JSON 파일입니다 — **한 번만 커밋하면 팀원은 파이프라인을 건너뛸 수 있습니다**. 온보딩, PR 리뷰, docs-as-code 워크플로에 적합합니다.
|
||||
|
||||
> **예시:** [GoogleCloudPlatform/microservices-demo (fork)](https://github.com/Lum1104/microservices-demo) — 커밋된 그래프를 포함한 Go / Java / Python / Node 레퍼런스 프로젝트.
|
||||
|
||||
**커밋할 대상:** `.understand-anything/` 내부의 모든 파일. 단, `intermediate/` 와 `diff-overlay.json` 은 제외합니다 (이들은 로컬 임시 파일입니다).
|
||||
|
||||
```gitignore
|
||||
.understand-anything/intermediate/
|
||||
.understand-anything/diff-overlay.json
|
||||
```
|
||||
|
||||
**최신 상태 유지:** `/understand --auto-update` 를 활성화하면 post-commit 훅이 그래프를 증분 업데이트하여 각 커밋마다 일치하는 그래프가 유지됩니다. 또는 릴리스 전에 `/understand` 를 수동으로 다시 실행하세요.
|
||||
|
||||
**대용량 그래프 (10 MB 이상):** **git-lfs** 로 추적합니다.
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs track ".understand-anything/*.json"
|
||||
git add .gitattributes .understand-anything/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 작동 원리
|
||||
|
||||
### 멀티 에이전트 파이프라인
|
||||
|
||||
@@ -248,6 +248,31 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und
|
||||
|
||||
---
|
||||
|
||||
## 📦 Share the Graph with Your Team
|
||||
|
||||
The graph is just JSON — **commit it once, and teammates skip the pipeline**. Good for onboarding, PR reviews, and docs-as-code.
|
||||
|
||||
> **Example:** [GoogleCloudPlatform/microservices-demo (fork)](https://github.com/Lum1104/microservices-demo) — Go / Java / Python / Node reference with a committed graph.
|
||||
|
||||
**What to commit:** everything in `.understand-anything/` *except* `intermediate/` and `diff-overlay.json` (those are local scratch).
|
||||
|
||||
```gitignore
|
||||
.understand-anything/intermediate/
|
||||
.understand-anything/diff-overlay.json
|
||||
```
|
||||
|
||||
**Keep it fresh:** enable `/understand --auto-update` — a post-commit hook incrementally patches the graph so each commit lands with a matching graph. Or re-run `/understand` manually before releases.
|
||||
|
||||
**Large graphs (10 MB+):** track with **git-lfs**.
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs track ".understand-anything/*.json"
|
||||
git add .gitattributes .understand-anything/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Under the Hood
|
||||
|
||||
### Multi-Agent Pipeline
|
||||
|
||||
@@ -248,6 +248,31 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und
|
||||
|
||||
---
|
||||
|
||||
## 📦 Grafı Ekibinizle Paylaşın
|
||||
|
||||
Graf yalnızca bir JSON dosyasıdır — **bir kez commit'leyin, ekip arkadaşlarınız pipeline'ı çalıştırmadan kullansın**. Yeni üye oryantasyonu, PR incelemeleri ve docs-as-code iş akışları için idealdir.
|
||||
|
||||
> **Örnek:** [GoogleCloudPlatform/microservices-demo (fork)](https://github.com/Lum1104/microservices-demo) — commit'lenmiş grafı içeren Go / Java / Python / Node çok dilli referans projesi.
|
||||
|
||||
**Neyi commit'leyin:** `.understand-anything/` içindeki her şey, *ancak* `intermediate/` ve `diff-overlay.json` hariç (bunlar yerel geçici dosyalardır).
|
||||
|
||||
```gitignore
|
||||
.understand-anything/intermediate/
|
||||
.understand-anything/diff-overlay.json
|
||||
```
|
||||
|
||||
**Güncel tutun:** `/understand --auto-update` etkinleştirin — bir post-commit kancası grafı artımlı olarak yamalar, böylece her commit eşleşen bir grafla birlikte gelir. Veya sürümden önce `/understand` komutunu elle yeniden çalıştırın.
|
||||
|
||||
**Büyük graflar (10 MB+):** **git-lfs** ile takip edin.
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs track ".understand-anything/*.json"
|
||||
git add .gitattributes .understand-anything/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Kaputun Altında
|
||||
|
||||
### Çok-Ajan Hattı
|
||||
|
||||
@@ -247,6 +247,31 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und
|
||||
|
||||
---
|
||||
|
||||
## 📦 与团队共享知识图谱
|
||||
|
||||
图谱就是一份 JSON 文件——**提交一次，团队成员就可以跳过整条流水线**。适合新人上手、PR 评审和 docs-as-code 工作流。
|
||||
|
||||
> **示例：** [GoogleCloudPlatform/microservices-demo（fork）](https://github.com/Lum1104/microservices-demo) —— 包含已提交图谱的 Go / Java / Python / Node 多语言参考项目。
|
||||
|
||||
**需要提交的内容：** `.understand-anything/` 下的全部文件，*除了* `intermediate/` 和 `diff-overlay.json`（这些是本地临时文件）。
|
||||
|
||||
```gitignore
|
||||
.understand-anything/intermediate/
|
||||
.understand-anything/diff-overlay.json
|
||||
```
|
||||
|
||||
**保持最新：** 启用 `/understand --auto-update` —— 一个 post-commit 钩子会增量更新图谱，每次提交都能得到匹配的图谱版本。也可以在发布前手动重跑 `/understand`。
|
||||
|
||||
**大型图谱（10 MB 以上）：** 使用 **git-lfs** 跟踪。
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs track ".understand-anything/*.json"
|
||||
git add .gitattributes .understand-anything/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 技术原理
|
||||
|
||||
### 多智能体架构
|
||||
|
||||
@@ -247,6 +247,31 @@ Fetch and follow instructions from https://raw.githubusercontent.com/Lum1104/Und
|
||||
|
||||
---
|
||||
|
||||
## 📦 與團隊共享知識圖譜
|
||||
|
||||
圖譜就是一份 JSON 檔案——**提交一次，團隊成員就可以跳過整條流水線**。適合新人上手、PR 審查和 docs-as-code 工作流程。
|
||||
|
||||
> **範例：** [GoogleCloudPlatform/microservices-demo（fork）](https://github.com/Lum1104/microservices-demo) —— 包含已提交圖譜的 Go / Java / Python / Node 多語言參考專案。
|
||||
|
||||
**需要提交的內容：** `.understand-anything/` 底下的全部檔案，*除了* `intermediate/` 與 `diff-overlay.json`（這些是本機暫存檔）。
|
||||
|
||||
```gitignore
|
||||
.understand-anything/intermediate/
|
||||
.understand-anything/diff-overlay.json
|
||||
```
|
||||
|
||||
**保持最新：** 啟用 `/understand --auto-update` —— 一個 post-commit 掛鉤會增量更新圖譜，讓每次提交都有對應的圖譜版本。也可以在發布前手動重跑 `/understand`。
|
||||
|
||||
**大型圖譜（10 MB 以上）：** 使用 **git-lfs** 追蹤。
|
||||
|
||||
```bash
|
||||
git lfs install
|
||||
git lfs track ".understand-anything/*.json"
|
||||
git add .gitattributes .understand-anything/
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔧 技術原理
|
||||
|
||||
### 多智能體架構
|
||||
|
||||
Reference in New Issue
Block a user