Skip to content

Enhance multi-agent pipeline documentation #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Omar-Basel-ALkhasawneh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Enhance multi-agent pipeline documentation #190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,19 +260,22 @@ git add .gitattributes .understand-anything/

### Multi-Agent Pipeline

The `/understand` command orchestrates 5 specialized agents, and `/understand-domain` adds a 6th:

| Agent | Role |
|-------|------|
| `project-scanner` | Discover files, detect languages and frameworks |
| `file-analyzer` | Extract functions, classes, imports; produce graph nodes and edges |
| `architecture-analyzer` | Identify architectural layers |
| `tour-builder` | Generate guided learning tours |
| `graph-reviewer` | Validate graph completeness and referential integrity (runs inline by default; use `--review` for full LLM review) |
| `domain-analyzer` | Extract business domains, flows, and process steps (used by `/understand-domain`) |
| `article-analyzer` | Extract entities, claims, and implicit relationships from wiki articles (used by `/understand-knowledge`) |

File analyzers run in parallel (up to 5 concurrent, 20-30 files per batch). Supports incremental updates — only re-analyzes files that changed since the last run.
The `/understand` command orchestrates 5 specialized agents, `/understand-domain` adds a 6th, and `/understand-knowledge` adds a 7th:

| Agent | Role | Used By |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------- |
| `project-scanner` | Discovers files, detects languages and frameworks | `/understand` |
| `file-analyzer` | Extracts functions, classes, imports; produces graph nodes and edges | `/understand` |
| `architecture-analyzer` | Identifies architectural layers | `/understand` |
| `tour-builder` | Generates guided learning tours | `/understand` |
| `graph-reviewer` | Validates graph completeness and referential integrity. Runs inline by default; use `--review` for full LLM review | `/understand` |
| `domain-analyzer` | Extracts business domains, flows, and process steps | `/understand-domain` |
| `article-analyzer` | Extracts entities, claims, and implicit relationships from wiki articles | `/understand-knowledge` |

File analyzers run in parallel, up to 5 concurrent workers and 20–30 files per batch.

The pipeline also supports incremental updates: only files changed since the last run are re-analyzed.


---

Expand Down