docs: update hub/ layout in READMEs to match actual files - #116
Conversation
Add missing hub files to tree diagrams: - incremental.py (committed-diff / --quick agent-group refresh) - host_runner.py (local CLI backend, no API key) - storage.py (generation dirs + current.json) - language_adapters/ (language-specific adapters) Update agents.py comment to include refresh swarm agents (ScanAnalyst/ArchitectureReviewer/ConventionWriter) alongside ask swarm agents (ContextCurator/DeepAnalyst/AnswerSynthesizer). Co-authored-by: JingWen Fan <study8677@users.noreply.github.com>
Change from conceptual names (ContextCurator/DeepAnalyst/AnswerSynthesizer) to real Agent instances: - Refresh swarm: ScanAnalyst → ArchitectureReviewer → ConventionWriter - Ask swarm: Router / ModuleAgent / GitAgent ContextCurator/DeepAnalyst/AnswerSynthesizer appear only in the module docstring, not as actual Agent(name=...) instances. Co-authored-by: JingWen Fan <study8677@users.noreply.github.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8534635227
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ├── config.py # Pydantic configuration | ||
| ├── hub/ # ★ Core: multi-agent cluster | ||
| │ ├── agents.py # Router + ModuleAgent + GitAgent | ||
| │ ├── agents.py # Refresh/Ask Swarm agents (ScanAnalyst/ArchitectureReviewer/ConventionWriter + ContextCurator/DeepAnalyst/AnswerSynthesizer) |
There was a problem hiding this comment.
For readers using this layout to understand agents.py, this now documents an ask swarm that does not exist: ask_pipeline.py calls build_reviewer_agent(), which delegates to build_ask_swarm() and constructs a Router, dynamic Module_* workers, and a GitAgent; ContextCurator, DeepAnalyst, and AnswerSynthesizer occur only in a stale module docstring and are never instantiated. The same inaccurate replacement appears in all three root READMEs, so retain the refresh-agent names but describe the implemented Router/ModuleAgent/GitAgent ask path.
Useful? React with 👍 / 👎.
2 participants
Small leftover docs patch following #115 merge.
Changes
Updated the "Two Packages, One Workflow" tree diagram in all three root READMEs (README.md, README_CN.md, README_ES.md) to reflect the actual files in
engine/repobrain_engine/hub/:Added missing hub files
incremental.py— committed-diff / --quick agent-group refreshhost_runner.py— local CLI backend (no API key)storage.py— generation dirs + current.jsonlanguage_adapters/— language-specific code adaptersUpdated agents.py comment to use actual Agent names
Changed to:
Refresh swarm (ScanAnalyst → ArchitectureReviewer → ConventionWriter) + Ask swarm (Router / ModuleAgent / GitAgent)These are the real
Agent(name=...)instances. The previous version incorrectly listed ContextCurator/DeepAnalyst/AnswerSynthesizer, which appear only in the module docstring as conceptual descriptions, not as actual agent instances.All changes align with the complete layout already present in
docs/zh/README.md(merged in #115).Verification
engine/repobrain_engine/hub/