Skip to content

docs: add Architecture reference with all src/ modules documented#1217

Merged
OneStepAt4time merged 1 commit intomainfrom
docs/architecture-modules
Apr 5, 2026
Merged

docs: add Architecture reference with all src/ modules documented#1217
OneStepAt4time merged 1 commit intomainfrom
docs/architecture-modules

Conversation

@OneStepAt4time
Copy link
Copy Markdown
Owner

Documents all 60+ modules in src/ organized into 10 logical layers:

  1. Entry & Configuration — cli, startup, config, auth
  2. Session Management — session, tmux, terminal-parser, transcript, jsonl-watcher
  3. Agent Integration (MCP) — mcp-server, tool-registry, handshake
  4. Orchestration — pipeline, consensus, swarm-monitor
  5. Intelligence & Templates — model-router, template-store, continuation-pointer, question-manager
  6. Monitoring & Events — monitor, events, sse-writer, ws-terminal
  7. Permissions — permission-guard, evaluator, request-manager, routes
  8. Memory & Metrics — memory-bridge, memory-routes, metrics, screenshot
  9. Hooks — hooks, hook, hook-settings
  10. Shared Utilities — api-contracts, validation, ssrf, retry, logger, diagnostics, etc.

Plus: request flow diagram.

Closes the DX gap — every module now has a documented purpose.

- Module overview tree with file-level descriptions
- 10 logical layers: Entry, Session, MCP, Orchestration, Intelligence, Monitoring, Permissions, Memory, Hooks, Utilities
- Module tables with purpose for every exported file
- Request flow diagram (ASCII)
- Covers: memory-bridge, model-router, consensus, template-store, pipeline, and all other previously undocumented modules
Copy link
Copy Markdown
Contributor

@aegis-gh-agent aegis-gh-agent bot left a comment

Choose a reason for hiding this comment

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

Comprehensive architecture reference. All 60+ modules documented across 10 logical layers with clear purpose descriptions. Approved.

@OneStepAt4time OneStepAt4time merged commit 280f6f6 into main Apr 5, 2026
10 checks passed
@OneStepAt4time OneStepAt4time deleted the docs/architecture-modules branch April 5, 2026 15:41
Copy link
Copy Markdown
Contributor

@aegis-gh-agent aegis-gh-agent bot left a comment

Choose a reason for hiding this comment

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

LGTM. Architecture reference for all 60+ src/ modules. 10 logical layers. Milestone #14. Squash merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant