Skip to content

docs: update documentation to match current codebase (2026-08) #115

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

Merged
study8677 merged 3 commits into from
Aug 27, 2026
Merged

docs: update documentation to match current codebase (2026-08) #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bbbf1e1
docs: update documentation to match current codebase (2026-08)
cursoragent Aug 27, 2026
d90fa16
docs: remove stale Phase 9 navigation references
cursoragent Aug 27, 2026
0b17957
docs: fix doubled engine/ prefix in ZERO_CONFIG paths
cursoragent Aug 27, 2026
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
6 changes: 3 additions & 3 deletions docs/en/MCP_INTEGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,15 +133,15 @@ if __name__ == "__main__":

### Register Custom Server

1. Save your server to `repobrain_engine/tools/my_server.py`
1. Save your server to `engine/repobrain_engine/tools/my_server.py`
2. Add to `mcp_servers.json`:

```json
{
"name": "my-analysis",
"transport": "stdio",
"command": "python",
"args": ["repobrain_engine/tools/my_server.py"],
"args": ["engine/repobrain_engine/tools/my_server.py"],
"enabled": true
}
```
Expand Down Expand Up @@ -197,7 +197,7 @@ manager.shutdown()
### Server won't connect
```bash
# Check if server process starts
python repobrain_engine/tools/my_server.py
python engine/repobrain_engine/tools/my_server.py

# Verify command exists
which npx
Expand Down
12 changes: 6 additions & 6 deletions docs/en/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ knowledge engine for grounded codebase Q&A.
- **[Multi-Agent Swarm](SWARM_PROTOCOL.md)** — Orchestrate specialist agents for complex tasks

### Planning & Vision
- **[Development Roadmap](ROADMAP.md)** — Current progress and future plans through Phase 9
- **[Development Roadmap](ROADMAP.md)** — Completed phases and architectural vision

## 🌟 Key Features

Expand Down Expand Up @@ -74,7 +74,7 @@ server.

### For DevOps/Deployment
1. Read [Quick Start](QUICK_START.md) Docker section
2. Check [Development Roadmap](ROADMAP.md) Phase 9 (Enterprise Core)
2. Understand [Sandbox Execution](SANDBOX.md) safety boundaries
3. Configure MCP servers in [MCP Integration](MCP_INTEGRATION.md)

### For Architects
Expand All @@ -101,7 +101,7 @@ server.
A: Run `rb-setup` and choose one of the OpenAI-compatible providers it offers: OpenAI, DeepSeek, Groq, DashScope, NVIDIA NIM, Ollama, or a custom endpoint. The command writes `OPENAI_BASE_URL`, `OPENAI_API_KEY`, and `OPENAI_MODEL`.

**Q: How do I add a custom tool?**
A: Drop a Python file in `repobrain_engine/tools/` with your functions. No registration needed! See [Zero-Config Features](ZERO_CONFIG.md).
A: Drop a Python file in `engine/repobrain_engine/tools/` with your functions. No registration needed! See [Zero-Config Features](ZERO_CONFIG.md).

**Q: How do I initialize a fresh project from this template?**
A: Use the `agent-repo-init` skill in `quick` or `full` mode, or run `skills/agent-repo-init/scripts/init_project.py`. See [Zero-Config Features](ZERO_CONFIG.md).
Expand Down Expand Up @@ -136,7 +136,7 @@ Have an architectural idea? Ideas are contributions too!
[Propose your thought](https://github.com/study8677/repobrain/issues/new)

### Submit Code
Ready to code? Check the [Roadmap](ROADMAP.md) Phase 9 for open areas.
Ready to code? Check the [Roadmap](ROADMAP.md) to understand the current architecture.

### Improve Docs
See a typo or unclear section? Submit a PR to improve the docs!
Expand All @@ -162,7 +162,7 @@ This project is licensed under the **MIT License**. See [LICENSE](../../LICENSE)

---

**Latest Update:** April 2026
**Version:** Phase 10 (Knowledge Hub) ✅ — structured evidence pipeline + multi-language module support
**Latest Update:** August 2026
**Current Architecture:** Generative knowledge hub + local host-runner + incremental agent-group refresh + structured evidence verification

Friendly Link: [LINUX DO](https://linux.do/)
27 changes: 14 additions & 13 deletions docs/en/ROADMAP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ one IDE.
| 6️⃣ **Dynamic Discovery** | ✅ Complete | Auto tool & context loading |
| 7️⃣ **Multi-Agent Swarm** | ✅ Complete | Router-Worker orchestration |
| 8️⃣ **MCP Integration** | ✅ Complete | Model Context Protocol support |
| 9️⃣ **Enterprise Core** | 🚀 In Progress | Safety boundaries, observability, deployment polish |
| 9️⃣ **Enterprise Core** | ✅ Complete | Safety boundaries, observability, deployment polish |

@chatgpt-codex-connector chatgpt-codex-connector Bot Aug 27, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Keep the Phase 9 status internally consistent

This newly marks Enterprise Core complete, while the same roadmap still labels Phase 9 “In Progress” at line 102 and describes major portions such as orchestrated flows, distributed agents, observability, and integrations as proposed or planned. Readers and prospective contributors cannot determine the actual project status; either retain the in-progress status or update the remaining Phase 9 section to identify what was completed.

Useful? React with 👍 / 👎.

| 🔟 **Knowledge Hub** | ✅ Complete | Multi-agent project context system |

## ✅ Completed Phases
Expand Down Expand Up @@ -73,7 +73,7 @@ one IDE.
**Goal**: Zero-config tool and knowledge loading

**Achievements:**
- Automatic tool discovery from `repobrain_engine/tools/`
- Automatic tool discovery from `engine/repobrain_engine/tools/`
- Auto-injection from `.context/` files
- Hot reload on file changes
- Docstring-based help generation
Expand All @@ -82,10 +82,10 @@ one IDE.
**Goal**: Collaborative multi-specialist execution

**Achievements:**
- Router-Worker agent architecture
- Specialist agents (Coder, Reviewer, Researcher)
- Task decomposition and synthesis
- Artifact coordination
- **Refresh Swarm**: Three-agent handoff chain (ScanAnalyst → ArchitectureReviewer → ConventionWriter) for project analysis
- **Ask Swarm**: Dynamic Router-Worker pattern with per-module agents for grounded Q&A
- Module-based question routing with file evidence
- Git history integration for change tracking

### Phase 8: MCP Integration ✅
**Goal**: Universal external tool connectivity
Expand Down Expand Up @@ -246,20 +246,21 @@ Ready to code? Pick a product-hardening component:
**Completed:** March 2026

**Achievements:**
- Hub module (`repobrain_engine/hub/`) with scanner, agents, and pipeline
- Hub module (`engine/repobrain_engine/hub/`) with scanner, agents, refresh/ask pipelines
- `rb-refresh` — scans project and generates `.repobrain/conventions.md` via LLM
- `rb-ask` — answers project questions using reviewer agent
- `rb report` / `rb log-decision` — local memory and decision logging
- OpenAI Agent SDK integration with LiteLLM for model flexibility

## 📈 Adoption Timeline
## 📈 Development Timeline

- **2024 H2**: Foundation through MCP Integration (Phases 1–8) — completed
- **2025**: Enterprise Core (Phase 9) — sandbox MVP, safety docs, observability
- **2026 Q1**: Knowledge Hub (Phase 10) — completed
- **2026+**: public repository knowledge engine hardening
- **2024 H2**: Foundation through MCP Integration (Phases 1–8) ✅
- **2025**: Enterprise Core (Phase 9) — sandbox MVP, safety docs, observability ✅
- **2026 Q1–Q2**: Knowledge Hub (Phase 10) — generation storage, structured evidence, multi-language adapters ✅
- **2026 Q3** (current): Host-runner backend, incremental refresh, agent-group architecture ✅
- **2026+**: Continued refinement and community-driven features

*(Timeline is aspirational and dependent on community adoption)*
*(Development is community-driven and evolves based on real-world usage)*

## 💡 Product Use Cases

Expand Down
Loading