Skip to content

docs: add claude-code substrate to index and structure docs [doc-updater] #2718

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
jwbron merged 2 commits into from
May 19, 2026
Merged

docs: add claude-code substrate to index and structure docs [doc-updater] #2718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dea422
docs: add claude-code substrate to index and structure docs
jwbron May 19, 2026
627b944
docs: fix substrate/claude_code listing per reviewer feedback
egg-reviewer[bot] May 19, 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
15 changes: 15 additions & 0 deletions docs/development/STRUCTURE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,21 @@ orchestrator/
├── status_reporter.py # Real-time status reporter for collaborators
├── unified_sse.py # Unified SSE stream for all pipelines
├── webhooks.py # GitHub webhook handlers
├── substrate/ # Substrate-swap abstraction layer (walking-skeleton #2623): four Protocol interfaces + env-var-selected factory
│ ├── __init__.py # `select_substrate(env)` factory; reads `EGG_SUBSTRATE` (`k3s` or `claude-code`)
│ ├── spawner.py # `AgentSpawner` protocol + `AgentResult` dataclass
│ ├── message_bus.py # `MessageBus` protocol
│ ├── policy.py # `PolicyEnforcer` protocol
│ ├── worktree.py # `WorktreeManager` protocol
│ ├── k3s_adapter.py # `K3sSpawnerAdapter` shim wrapping `KubernetesSpawner.create_concurrent_spawn_fn`
│ ├── in_process.py # `run_pipeline_in_process()` generator entry point (claude-code substrate only)
│ └── claude_code/ # Claude-Code-native implementations
│ ├── spawner.py # `ClaudeCodeSpawner` — runs `egg_harness.run_agent` in-process (Agent-tool dispatch is a follow-up; see ADR "Open work")
│ ├── hook_entry.py # Standalone `python3 -m` PreToolUse hook script invoked by Claude Code (Bash/Write/Edit parser; fail-closed on ambiguous shapes)
│ ├── message_bus.py # `InProcessMessageBus` — subclasses `MessageStore` (in-memory)
│ ├── policy.py # `PolicyEnforcer` adapter (`check_write` + `install`) wrapping the `hook_entry.py` script
│ ├── settings.template.json # Claude Code settings template registering `hook_entry.py` as the PreToolUse hook
│ └── worktree.py # `LocalWorktreeManager` — per-agent worktrees under `~/.egg-worktrees/`
├── overseer/ # Overseer agent package (LLM-powered tier of pipeline health monitoring)
│ ├── classifier.py # Haiku-tier classifiers (stall, loop, error triage, off-track detection)
│ ├── decision_maker.py # Sonnet/Opus-tier decision-maker (corrective actions, redirect messages)
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ This index helps both humans and LLMs navigate the documentation efficiently.
| [The Agentic Feedback Loop](architecture/agentic-feedback-loop.md) | The foundational work-review-feedback cycle that drives quality |
| [Why egg Works](architecture/collaboration-effectiveness.md) | How the public, sandboxed, async model delivers safety and collaboration |
| [Integration-Test Trust Boundary](architecture/integration-test-trust-boundary.md) | Test execution contexts (in-sandbox-agent / trusted-CI-runner / human-operator) and fixture tiers; authoritative reference for plan-phase Trust-Boundary Audit (#2594) |
| [Claude Code Substrate](architecture/claude-code-substrate.md) | Substrate-swap walking-skeleton (#2623): four `Protocol`s (`AgentSpawner` / `MessageBus` / `PolicyEnforcer` / `WorktreeManager`) under `orchestrator/substrate/`, env-var-selected via `EGG_SUBSTRATE`, with Claude-Code-native implementations and an in-process orchestrator generator (`run_pipeline_in_process`) |

### Development

Expand Down
Loading